blob: 790a573bbe00c6f6b2afd27dc8fac862d222ec9b [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)
4 * kernel/kprobes.c
5 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Copyright (C) IBM Corporation, 2002, 2004
7 *
8 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
9 * Probes initial implementation (includes suggestions from
10 * Rusty Russell).
11 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
12 * hlists and exceptions notifier as suggested by Andi Kleen.
13 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
14 * interface to access function arguments.
15 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
16 * exceptions notifier to be first on the priority list.
Hien Nguyenb94cce92005-06-23 00:09:19 -070017 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
18 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
19 * <prasanna@in.ibm.com> added function-return probes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 */
21#include <linux/kprobes.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/hash.h>
23#include <linux/init.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080024#include <linux/slab.h>
Randy Dunlape3869792007-05-08 00:27:01 -070025#include <linux/stddef.h>
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070027#include <linux/moduleloader.h>
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070028#include <linux/kallsyms.h>
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080029#include <linux/freezer.h>
Srinivasa Ds346fd592007-02-20 13:57:54 -080030#include <linux/seq_file.h>
31#include <linux/debugfs.h>
Masami Hiramatsub2be84d2010-02-25 08:34:15 -050032#include <linux/sysctl.h>
Christoph Hellwig1eeb66a2007-05-08 00:27:03 -070033#include <linux/kdebug.h>
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -050034#include <linux/memory.h>
Masami Hiramatsu4554dbc2010-02-02 16:49:18 -050035#include <linux/ftrace.h>
Masami Hiramatsuafd66252010-02-25 08:34:07 -050036#include <linux/cpu.h>
Jason Baronbf5438fc2010-09-17 11:09:00 -040037#include <linux/jump_label.h>
Peter Zijlstrafa68bd02021-06-28 13:24:12 +020038#include <linux/static_call.h>
Adrian Hunter69e49082020-05-12 15:19:11 +030039#include <linux/perf_event.h>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070040
Christoph Hellwigbfd45be2016-10-11 13:52:22 -070041#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <asm/cacheflush.h>
43#include <asm/errno.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080044#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#define KPROBE_HASH_BITS 6
47#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
48
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070049
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070050static int kprobes_initialized;
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +090051/* kprobe_table can be accessed by
52 * - Normal hlist traversal and RCU add/del under kprobe_mutex is held.
53 * Or
54 * - RCU hlist traversal under disabling preempt (breakpoint handlers)
55 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
57
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070058/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070059static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070060
Masami Hiramatsu43948f52010-10-25 22:18:01 +090061/* This protects kprobe_table and optimizing_list */
62static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080063static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070064
Naveen N. Rao290e3072017-04-19 18:21:01 +053065kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
66 unsigned int __unused)
Naveen N. Rao49e0b462017-04-19 18:21:00 +053067{
68 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
69}
70
Masami Hiramatsu376e2422014-04-17 17:17:05 +090071/* Blacklist -- list of struct kprobe_blacklist_entry */
72static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070073
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080074#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070075/*
76 * kprobe->ainsn.insn points to the copy of the instruction to be
77 * single-stepped. x86_64, POWER4 and above have no-exec support and
78 * stepping on the instruction on a vmalloced/kmalloced/data page
79 * is a recipe for disaster
80 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070081struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -040082 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070083 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -070084 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070085 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080086 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050087 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070088};
89
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050090#define KPROBE_INSN_PAGE_SIZE(slots) \
91 (offsetof(struct kprobe_insn_page, slot_used) + \
92 (sizeof(char) * (slots)))
93
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050094static int slots_per_page(struct kprobe_insn_cache *c)
95{
96 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
97}
98
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -080099enum kprobe_slot_state {
100 SLOT_CLEAN = 0,
101 SLOT_DIRTY = 1,
102 SLOT_USED = 2,
103};
104
Masami Hiramatsu63fef142017-08-18 17:24:00 +0900105void __weak *alloc_insn_page(void)
Heiko Carstensaf963972013-09-11 14:24:13 -0700106{
107 return module_alloc(PAGE_SIZE);
108}
109
Barry Song66ce7512021-06-30 18:56:31 -0700110static void free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700111{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030112 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700113}
114
Heiko Carstensc802d642013-09-11 14:24:11 -0700115struct kprobe_insn_cache kprobe_insn_slots = {
116 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700117 .alloc = alloc_insn_page,
118 .free = free_insn_page,
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300119 .sym = KPROBE_INSN_PAGE_SYM,
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500120 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
121 .insn_size = MAX_INSN_SIZE,
122 .nr_garbage = 0,
123};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900124static int collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800125
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700126/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800127 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700128 * We allocate an executable page if there's no room on existing ones.
129 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900130kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700131{
132 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700133 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700134
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900135 /* Since the slot array is not protected by rcu, we need a mutex */
Heiko Carstensc802d642013-09-11 14:24:11 -0700136 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700137 retry:
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900138 rcu_read_lock();
139 list_for_each_entry_rcu(kip, &c->pages, list) {
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500140 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700141 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500142 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800143 if (kip->slot_used[i] == SLOT_CLEAN) {
144 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700145 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700146 slot = kip->insns + (i * c->insn_size);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900147 rcu_read_unlock();
Heiko Carstensc802d642013-09-11 14:24:11 -0700148 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700149 }
150 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500151 /* kip->nused is broken. Fix it. */
152 kip->nused = slots_per_page(c);
153 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700154 }
155 }
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900156 rcu_read_unlock();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700157
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800158 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500159 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800160 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500161
162 /* All out of space. Need to allocate a new page. */
163 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700164 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700165 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700166
167 /*
168 * Use module_alloc so this page is within +/- 2GB of where the
169 * kernel image and loaded module images reside. This is required
170 * so x86_64 can correctly handle the %rip-relative fixups.
171 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700172 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700173 if (!kip->insns) {
174 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700175 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700176 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400177 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500178 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800179 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700180 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800181 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700182 kip->cache = c;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900183 list_add_rcu(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700184 slot = kip->insns;
Adrian Hunter69e49082020-05-12 15:19:11 +0300185
186 /* Record the perf ksymbol register event after adding the page */
187 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL, (unsigned long)kip->insns,
188 PAGE_SIZE, false, c->sym);
Heiko Carstensc802d642013-09-11 14:24:11 -0700189out:
190 mutex_unlock(&c->mutex);
191 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800192}
193
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800194/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900195static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800196{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800197 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800198 kip->nused--;
199 if (kip->nused == 0) {
200 /*
201 * Page is no longer in use. Free it unless
202 * it's the last one. We keep the last one
203 * so as not to have to set it up again the
204 * next time somebody inserts a probe.
205 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500206 if (!list_is_singular(&kip->list)) {
Adrian Hunter69e49082020-05-12 15:19:11 +0300207 /*
208 * Record perf ksymbol unregister event before removing
209 * the page.
210 */
211 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL,
212 (unsigned long)kip->insns, PAGE_SIZE, true,
213 kip->cache->sym);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900214 list_del_rcu(&kip->list);
215 synchronize_rcu();
Heiko Carstensaf963972013-09-11 14:24:13 -0700216 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800217 kfree(kip);
218 }
219 return 1;
220 }
221 return 0;
222}
223
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900224static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800225{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400226 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800227
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500228 /* Ensure no-one is interrupted on the garbages */
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -0800229 synchronize_rcu();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800230
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500231 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800232 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233 if (kip->ngarbage == 0)
234 continue;
235 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500236 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900237 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800238 break;
239 }
240 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500241 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800242 return 0;
243}
244
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900245void __free_insn_slot(struct kprobe_insn_cache *c,
246 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500247{
248 struct kprobe_insn_page *kip;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900249 long idx;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500250
Heiko Carstensc802d642013-09-11 14:24:11 -0700251 mutex_lock(&c->mutex);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900252 rcu_read_lock();
253 list_for_each_entry_rcu(kip, &c->pages, list) {
254 idx = ((long)slot - (long)kip->insns) /
255 (c->insn_size * sizeof(kprobe_opcode_t));
256 if (idx >= 0 && idx < slots_per_page(c))
Heiko Carstensc802d642013-09-11 14:24:11 -0700257 goto out;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900258 }
259 /* Could not find this slot. */
260 WARN_ON(1);
261 kip = NULL;
262out:
263 rcu_read_unlock();
264 /* Mark and sweep: this may sleep */
265 if (kip) {
266 /* Check double free */
267 WARN_ON(kip->slot_used[idx] != SLOT_USED);
268 if (dirty) {
269 kip->slot_used[idx] = SLOT_DIRTY;
270 kip->ngarbage++;
271 if (++c->nr_garbage > slots_per_page(c))
272 collect_garbage_slots(c);
273 } else {
274 collect_one_slot(kip, idx);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500275 }
276 }
Heiko Carstensc802d642013-09-11 14:24:11 -0700277 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500278}
279
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900280/*
281 * Check given address is on the page of kprobe instruction slots.
282 * This will be used for checking whether the address on a stack
283 * is on a text area or not.
284 */
285bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
286{
287 struct kprobe_insn_page *kip;
288 bool ret = false;
289
290 rcu_read_lock();
291 list_for_each_entry_rcu(kip, &c->pages, list) {
292 if (addr >= (unsigned long)kip->insns &&
293 addr < (unsigned long)kip->insns + PAGE_SIZE) {
294 ret = true;
295 break;
296 }
297 }
298 rcu_read_unlock();
299
300 return ret;
301}
302
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300303int kprobe_cache_get_kallsym(struct kprobe_insn_cache *c, unsigned int *symnum,
304 unsigned long *value, char *type, char *sym)
305{
306 struct kprobe_insn_page *kip;
307 int ret = -ERANGE;
308
309 rcu_read_lock();
310 list_for_each_entry_rcu(kip, &c->pages, list) {
311 if ((*symnum)--)
312 continue;
313 strlcpy(sym, c->sym, KSYM_NAME_LEN);
314 *type = 't';
315 *value = (unsigned long)kip->insns;
316 ret = 0;
317 break;
318 }
319 rcu_read_unlock();
320
321 return ret;
322}
323
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500324#ifdef CONFIG_OPTPROBES
Christophe Leroy7ee3e972021-05-13 09:07:51 +0000325void __weak *alloc_optinsn_page(void)
326{
327 return alloc_insn_page();
328}
329
330void __weak free_optinsn_page(void *page)
331{
332 free_insn_page(page);
333}
334
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500335/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700336struct kprobe_insn_cache kprobe_optinsn_slots = {
337 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Christophe Leroy7ee3e972021-05-13 09:07:51 +0000338 .alloc = alloc_optinsn_page,
339 .free = free_optinsn_page,
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300340 .sym = KPROBE_OPTINSN_PAGE_SYM,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500341 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
342 /* .insn_size is initialized later */
343 .nr_garbage = 0,
344};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500345#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800346#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700347
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800348/* We have preemption disabled.. so it is safe to use __ versions */
349static inline void set_kprobe_instance(struct kprobe *kp)
350{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600351 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800352}
353
354static inline void reset_kprobe_instance(void)
355{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600356 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800357}
358
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800359/*
360 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800361 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800362 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800363 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800364 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900365struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366{
367 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800368 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Masami Hiramatsu6743ad42020-05-12 17:02:33 +0900371 hlist_for_each_entry_rcu(p, head, hlist,
372 lockdep_is_held(&kprobe_mutex)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 if (p->addr == addr)
374 return p;
375 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 return NULL;
378}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900379NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900381static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500382
383/* Return true if the kprobe is an aggregator */
384static inline int kprobe_aggrprobe(struct kprobe *p)
385{
386 return p->pre_handler == aggr_pre_handler;
387}
388
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900389/* Return true(!0) if the kprobe is unused */
390static inline int kprobe_unused(struct kprobe *p)
391{
392 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
393 list_empty(&p->list);
394}
395
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500396/*
397 * Keep all fields in the kprobe consistent
398 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900399static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500400{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900401 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
402 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500403}
404
405#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500406/* NOTE: change this value only with kprobe_mutex held */
407static bool kprobes_allow_optimization;
408
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500409/*
410 * Call all pre_handler on the list, but ignores its return value.
411 * This must be called from arch-dep optimized caller.
412 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900413void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500414{
415 struct kprobe *kp;
416
417 list_for_each_entry_rcu(kp, &p->list, list) {
418 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
419 set_kprobe_instance(kp);
Naveen N. Rao4f3a8712017-10-17 13:48:34 +0530420 kp->pre_handler(kp, regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500421 }
422 reset_kprobe_instance();
423 }
424}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900425NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500426
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900427/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900428static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900429{
430 struct optimized_kprobe *op;
431
432 op = container_of(p, struct optimized_kprobe, kp);
433 arch_remove_optimized_kprobe(op);
434 arch_remove_kprobe(p);
435 kfree(op);
436}
437
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500438/* Return true(!0) if the kprobe is ready for optimization. */
439static inline int kprobe_optready(struct kprobe *p)
440{
441 struct optimized_kprobe *op;
442
443 if (kprobe_aggrprobe(p)) {
444 op = container_of(p, struct optimized_kprobe, kp);
445 return arch_prepared_optinsn(&op->optinsn);
446 }
447
448 return 0;
449}
450
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900451/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
452static inline int kprobe_disarmed(struct kprobe *p)
453{
454 struct optimized_kprobe *op;
455
456 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
457 if (!kprobe_aggrprobe(p))
458 return kprobe_disabled(p);
459
460 op = container_of(p, struct optimized_kprobe, kp);
461
462 return kprobe_disabled(p) && list_empty(&op->list);
463}
464
465/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900466static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900467{
468 struct optimized_kprobe *op;
469
470 if (kprobe_aggrprobe(p)) {
471 op = container_of(p, struct optimized_kprobe, kp);
472 if (!list_empty(&op->list))
473 return 1;
474 }
475 return 0;
476}
477
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500478/*
479 * Return an optimized kprobe whose optimizing code replaces
480 * instructions including addr (exclude breakpoint).
481 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900482static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500483{
484 int i;
485 struct kprobe *p = NULL;
486 struct optimized_kprobe *op;
487
488 /* Don't check i == 0, since that is a breakpoint case. */
489 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
490 p = get_kprobe((void *)(addr - i));
491
492 if (p && kprobe_optready(p)) {
493 op = container_of(p, struct optimized_kprobe, kp);
494 if (arch_within_optimized_kprobe(op, addr))
495 return p;
496 }
497
498 return NULL;
499}
500
501/* Optimization staging list, protected by kprobe_mutex */
502static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900503static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900504static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500505
506static void kprobe_optimizer(struct work_struct *work);
507static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
508#define OPTIMIZE_DELAY 5
509
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900510/*
511 * Optimize (replace a breakpoint with a jump) kprobes listed on
512 * optimizing_list.
513 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900514static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500515{
Andrea Righif1c6ece2019-08-12 20:43:02 +0200516 lockdep_assert_held(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500517 /*
518 * The optimization/unoptimization refers online_cpus via
519 * stop_machine() and cpu-hotplug modifies online_cpus.
520 * And same time, text_mutex will be held in cpu-hotplug and here.
521 * This combination can cause a deadlock (cpu-hotplug try to lock
522 * text_mutex but stop_machine can not be done because online_cpus
523 * has been changed)
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200524 * To avoid this deadlock, caller must have locked cpu hotplug
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500525 * for preventing cpu-hotplug outside of text_mutex locking.
526 */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200527 lockdep_assert_cpus_held();
528
529 /* Optimization never be done when disarmed */
530 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
531 list_empty(&optimizing_list))
532 return;
533
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900534 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900535}
536
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900537/*
538 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
539 * if need) kprobes listed on unoptimizing_list.
540 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900541static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900542{
543 struct optimized_kprobe *op, *tmp;
544
Andrea Righif1c6ece2019-08-12 20:43:02 +0200545 lockdep_assert_held(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200546 /* See comment in do_optimize_kprobes() */
547 lockdep_assert_cpus_held();
548
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900549 /* Unoptimization must be done anytime */
550 if (list_empty(&unoptimizing_list))
551 return;
552
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900553 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900554 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900555 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsuf66c0442019-11-27 14:57:04 +0900556 /* Switching from detour code to origin */
557 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900558 /* Disarm probes if marked disabled */
559 if (kprobe_disabled(&op->kp))
560 arch_disarm_kprobe(&op->kp);
561 if (kprobe_unused(&op->kp)) {
562 /*
563 * Remove unused probes from hash list. After waiting
564 * for synchronization, these probes are reclaimed.
565 * (reclaiming is done by do_free_cleaned_kprobes.)
566 */
567 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900568 } else
569 list_del_init(&op->list);
570 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900571}
572
573/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900574static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900575{
576 struct optimized_kprobe *op, *tmp;
577
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900578 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900579 list_del_init(&op->list);
Masami Hiramatsucbdd96f2018-09-11 19:21:09 +0900580 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
581 /*
582 * This must not happen, but if there is a kprobe
583 * still in use, keep it on kprobes hash list.
584 */
585 continue;
586 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900587 free_aggr_kprobe(&op->kp);
588 }
589}
590
591/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900592static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900593{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800594 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900595}
596
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900597/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900598static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900599{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900600 mutex_lock(&kprobe_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200601 cpus_read_lock();
Andrea Righif1c6ece2019-08-12 20:43:02 +0200602 mutex_lock(&text_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900603
604 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900605 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
606 * kprobes before waiting for quiesence period.
607 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900608 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900609
610 /*
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900611 * Step 2: Wait for quiesence period to ensure all potentially
612 * preempted tasks to have normally scheduled. Because optprobe
613 * may modify multiple instructions, there is a chance that Nth
614 * instruction is preempted. In that case, such tasks can return
615 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
616 * Note that on non-preemptive kernel, this is transparently converted
617 * to synchronoze_sched() to wait for all interrupts to have completed.
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900618 */
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900619 synchronize_rcu_tasks();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900620
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900621 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900622 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900623
624 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900625 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900626
Andrea Righif1c6ece2019-08-12 20:43:02 +0200627 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200628 cpus_read_unlock();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900629
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900630 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900631 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900632 kick_kprobe_optimizer();
Masami Hiramatsu1a0aa992020-05-12 17:02:56 +0900633
634 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900635}
636
637/* Wait for completing optimization and unoptimization */
Thomas Gleixner30e7d8942017-05-17 10:19:49 +0200638void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900639{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800640 mutex_lock(&kprobe_mutex);
641
642 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
643 mutex_unlock(&kprobe_mutex);
644
645 /* this will also make optimizing_work execute immmediately */
646 flush_delayed_work(&optimizing_work);
647 /* @optimizing_work might not have been queued yet, relax */
648 cpu_relax();
649
650 mutex_lock(&kprobe_mutex);
651 }
652
653 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500654}
655
Masami Hiramatsue4add242020-01-07 23:42:24 +0900656static bool optprobe_queued_unopt(struct optimized_kprobe *op)
657{
658 struct optimized_kprobe *_op;
659
660 list_for_each_entry(_op, &unoptimizing_list, list) {
661 if (op == _op)
662 return true;
663 }
664
665 return false;
666}
667
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500668/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900669static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500670{
671 struct optimized_kprobe *op;
672
673 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500674 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500675 (kprobe_disabled(p) || kprobes_all_disarmed))
676 return;
677
Masami Hiramatsu059053a2018-06-20 01:10:27 +0900678 /* kprobes with post_handler can not be optimized */
679 if (p->post_handler)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500680 return;
681
682 op = container_of(p, struct optimized_kprobe, kp);
683
684 /* Check there is no other kprobes at the optimized instructions */
685 if (arch_check_optimized_kprobe(op) < 0)
686 return;
687
688 /* Check if it is already optimized. */
Masami Hiramatsue4add242020-01-07 23:42:24 +0900689 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED) {
690 if (optprobe_queued_unopt(op)) {
691 /* This is under unoptimizing. Just dequeue the probe */
692 list_del_init(&op->list);
693 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500694 return;
Masami Hiramatsue4add242020-01-07 23:42:24 +0900695 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500696 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900697
Masami Hiramatsue4add242020-01-07 23:42:24 +0900698 /* On unoptimizing/optimizing_list, op must have OPTIMIZED flag */
699 if (WARN_ON_ONCE(!list_empty(&op->list)))
700 return;
701
702 list_add(&op->list, &optimizing_list);
703 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900704}
705
706/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900707static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900708{
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200709 lockdep_assert_cpus_held();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900710 arch_unoptimize_kprobe(op);
Masami Hiramatsuf66c0442019-11-27 14:57:04 +0900711 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500712}
713
714/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900715static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500716{
717 struct optimized_kprobe *op;
718
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900719 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
720 return; /* This is not an optprobe nor optimized */
721
722 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsue4add242020-01-07 23:42:24 +0900723 if (!kprobe_optimized(p))
724 return;
725
726 if (!list_empty(&op->list)) {
727 if (optprobe_queued_unopt(op)) {
728 /* Queued in unoptimizing queue */
729 if (force) {
730 /*
731 * Forcibly unoptimize the kprobe here, and queue it
732 * in the freeing list for release afterwards.
733 */
734 force_unoptimize_kprobe(op);
735 list_move(&op->list, &freeing_list);
736 }
737 } else {
738 /* Dequeue from the optimizing queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500739 list_del_init(&op->list);
Masami Hiramatsue4add242020-01-07 23:42:24 +0900740 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900741 }
742 return;
743 }
744
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900745 /* Optimized kprobe case */
Masami Hiramatsue4add242020-01-07 23:42:24 +0900746 if (force) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900747 /* Forcibly update the code: this is a special case */
748 force_unoptimize_kprobe(op);
Masami Hiramatsue4add242020-01-07 23:42:24 +0900749 } else {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900750 list_add(&op->list, &unoptimizing_list);
751 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500752 }
753}
754
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900755/* Cancel unoptimizing for reusing */
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900756static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900757{
758 struct optimized_kprobe *op;
759
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900760 /*
761 * Unused kprobe MUST be on the way of delayed unoptimizing (means
762 * there is still a relative jump) and disabled.
763 */
764 op = container_of(ap, struct optimized_kprobe, kp);
Masami Hiramatsu44585152018-04-28 21:36:33 +0900765 WARN_ON_ONCE(list_empty(&op->list));
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900766 /* Enable the probe again */
767 ap->flags &= ~KPROBE_FLAG_DISABLED;
768 /* Optimize it again (remove from op->list) */
Masami Hiramatsu5f843ed2019-04-15 15:01:25 +0900769 if (!kprobe_optready(ap))
770 return -EINVAL;
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900771
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900772 optimize_kprobe(ap);
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900773 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900774}
775
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500776/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900777static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500778{
779 struct optimized_kprobe *op;
780
781 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900782 if (!list_empty(&op->list))
783 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500784 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900785 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900786
787 if (kprobe_unused(p)) {
788 /* Enqueue if it is unused */
789 list_add(&op->list, &freeing_list);
790 /*
791 * Remove unused probes from the hash list. After waiting
792 * for synchronization, this probe is reclaimed.
793 * (reclaiming is done by do_free_cleaned_kprobes().)
794 */
795 hlist_del_rcu(&op->kp.hlist);
796 }
797
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900798 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500799 arch_remove_optimized_kprobe(op);
800}
801
Masami Hiramatsua4602462017-04-19 18:22:25 +0530802static inline
803void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
804{
805 if (!kprobe_ftrace(p))
806 arch_prepare_optimized_kprobe(op, p);
807}
808
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500809/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900810static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500811{
812 struct optimized_kprobe *op;
813
814 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530815 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500816}
817
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500818/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900819static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500820{
821 struct optimized_kprobe *op;
822
823 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
824 if (!op)
825 return NULL;
826
827 INIT_LIST_HEAD(&op->list);
828 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530829 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500830
831 return &op->kp;
832}
833
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900834static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500835
836/*
837 * Prepare an optimized_kprobe and optimize it
838 * NOTE: p must be a normal registered kprobe
839 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900840static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500841{
842 struct kprobe *ap;
843 struct optimized_kprobe *op;
844
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900845 /* Impossible to optimize ftrace-based kprobe */
846 if (kprobe_ftrace(p))
847 return;
848
Masami Hiramatsu25764282012-06-05 19:28:26 +0900849 /* For preparing optimization, jump_label_text_reserved() is called */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200850 cpus_read_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +0900851 jump_label_lock();
852 mutex_lock(&text_mutex);
853
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500854 ap = alloc_aggr_kprobe(p);
855 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900856 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500857
858 op = container_of(ap, struct optimized_kprobe, kp);
859 if (!arch_prepared_optinsn(&op->optinsn)) {
860 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900861 arch_remove_optimized_kprobe(op);
862 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900863 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500864 }
865
866 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900867 optimize_kprobe(ap); /* This just kicks optimizer thread */
868
869out:
870 mutex_unlock(&text_mutex);
871 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200872 cpus_read_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500873}
874
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900875static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500876{
877 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500878 struct kprobe *p;
879 unsigned int i;
880
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900881 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500882 /* If optimization is already allowed, just return */
883 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900884 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500885
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200886 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500887 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500888 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
889 head = &kprobe_table[i];
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +0900890 hlist_for_each_entry(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500891 if (!kprobe_disabled(p))
892 optimize_kprobe(p);
893 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200894 cpus_read_unlock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500895 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900896out:
897 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500898}
899
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +0900900#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900901static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500902{
903 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500904 struct kprobe *p;
905 unsigned int i;
906
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900907 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500908 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900909 if (!kprobes_allow_optimization) {
910 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500911 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900912 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500913
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200914 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500915 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500916 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
917 head = &kprobe_table[i];
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +0900918 hlist_for_each_entry(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500919 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900920 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500921 }
922 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200923 cpus_read_unlock();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900924 mutex_unlock(&kprobe_mutex);
925
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900926 /* Wait for unoptimizing completion */
927 wait_for_kprobe_optimizer();
928 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500929}
930
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900931static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500932int sysctl_kprobes_optimization;
933int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +0200934 void *buffer, size_t *length,
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500935 loff_t *ppos)
936{
937 int ret;
938
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900939 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500940 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
941 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
942
943 if (sysctl_kprobes_optimization)
944 optimize_all_kprobes();
945 else
946 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900947 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500948
949 return ret;
950}
951#endif /* CONFIG_SYSCTL */
952
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900953/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900954static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500955{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900956 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500957
958 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900959 _p = get_optimized_kprobe((unsigned long)p->addr);
960 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900961 /* Fallback to unoptimized kprobe */
962 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500963
964 arch_arm_kprobe(p);
965 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
966}
967
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900968/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900969static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500970{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900971 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500972
Wang Nan69d54b92015-02-13 14:40:26 -0800973 /* Try to unoptimize */
974 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500975
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900976 if (!kprobe_queued(p)) {
977 arch_disarm_kprobe(p);
978 /* If another kprobe was blocked, optimize it. */
979 _p = get_optimized_kprobe((unsigned long)p->addr);
980 if (unlikely(_p) && reopt)
981 optimize_kprobe(_p);
982 }
983 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500984}
985
986#else /* !CONFIG_OPTPROBES */
987
988#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900989#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500990#define kill_optimized_kprobe(p) do {} while (0)
991#define prepare_optimized_kprobe(p) do {} while (0)
992#define try_to_optimize_kprobe(p) do {} while (0)
993#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900994#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
995#define kprobe_disarmed(p) kprobe_disabled(p)
996#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500997
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900998static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900999{
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001000 /*
1001 * If the optimized kprobe is NOT supported, the aggr kprobe is
1002 * released at the same time that the last aggregated kprobe is
1003 * unregistered.
1004 * Thus there should be no chance to reuse unused kprobe.
1005 */
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001006 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001007 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001008}
1009
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001010static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001011{
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001012 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001013 kfree(p);
1014}
1015
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001016static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001017{
1018 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
1019}
1020#endif /* CONFIG_OPTPROBES */
1021
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001022#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001023static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +09001024 .func = kprobe_ftrace_handler,
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001025 .flags = FTRACE_OPS_FL_SAVE_REGS,
1026};
1027
1028static struct ftrace_ops kprobe_ipmodify_ops __read_mostly = {
1029 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -05001030 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001031};
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001032
1033static int kprobe_ipmodify_enabled;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001034static int kprobe_ftrace_enabled;
1035
1036/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001037static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001038{
1039 if (!kprobe_ftrace(p))
1040 return arch_prepare_kprobe(p);
1041
1042 return arch_prepare_kprobe_ftrace(p);
1043}
1044
1045/* Caller must lock kprobe_mutex */
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001046static int __arm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1047 int *cnt)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001048{
Jessica Yu12310e342018-01-10 00:51:23 +01001049 int ret = 0;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001050
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001051 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 0, 0);
Jessica Yu12310e342018-01-10 00:51:23 +01001052 if (ret) {
Masami Hiramatsu44585152018-04-28 21:36:33 +09001053 pr_debug("Failed to arm kprobe-ftrace at %pS (%d)\n",
1054 p->addr, ret);
Jessica Yu12310e342018-01-10 00:51:23 +01001055 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001056 }
Jessica Yu12310e342018-01-10 00:51:23 +01001057
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001058 if (*cnt == 0) {
1059 ret = register_ftrace_function(ops);
Jessica Yu12310e342018-01-10 00:51:23 +01001060 if (ret) {
1061 pr_debug("Failed to init kprobe-ftrace (%d)\n", ret);
1062 goto err_ftrace;
1063 }
1064 }
1065
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001066 (*cnt)++;
Jessica Yu12310e342018-01-10 00:51:23 +01001067 return ret;
1068
1069err_ftrace:
1070 /*
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001071 * At this point, sinec ops is not registered, we should be sefe from
1072 * registering empty filter.
Jessica Yu12310e342018-01-10 00:51:23 +01001073 */
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001074 ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
Jessica Yu12310e342018-01-10 00:51:23 +01001075 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001076}
1077
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001078static int arm_kprobe_ftrace(struct kprobe *p)
1079{
1080 bool ipmodify = (p->post_handler != NULL);
1081
1082 return __arm_kprobe_ftrace(p,
1083 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1084 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1085}
1086
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001087/* Caller must lock kprobe_mutex */
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001088static int __disarm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1089 int *cnt)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001090{
Jessica Yu297f9232018-01-10 00:51:24 +01001091 int ret = 0;
1092
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001093 if (*cnt == 1) {
1094 ret = unregister_ftrace_function(ops);
Jessica Yu297f9232018-01-10 00:51:24 +01001095 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (%d)\n", ret))
1096 return ret;
1097 }
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001098
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001099 (*cnt)--;
Jessica Yu297f9232018-01-10 00:51:24 +01001100
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001101 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
Masami Hiramatsu44585152018-04-28 21:36:33 +09001102 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (%d)\n",
1103 p->addr, ret);
Jessica Yu297f9232018-01-10 00:51:24 +01001104 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001105}
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001106
1107static int disarm_kprobe_ftrace(struct kprobe *p)
1108{
1109 bool ipmodify = (p->post_handler != NULL);
1110
1111 return __disarm_kprobe_ftrace(p,
1112 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1113 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1114}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001115#else /* !CONFIG_KPROBES_ON_FTRACE */
Muchun Song10de7952020-08-06 01:20:46 +08001116static inline int prepare_kprobe(struct kprobe *p)
1117{
1118 return arch_prepare_kprobe(p);
1119}
1120
1121static inline int arm_kprobe_ftrace(struct kprobe *p)
1122{
1123 return -ENODEV;
1124}
1125
1126static inline int disarm_kprobe_ftrace(struct kprobe *p)
1127{
1128 return -ENODEV;
1129}
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001130#endif
1131
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001132/* Arm a kprobe with text_mutex */
Jessica Yu12310e342018-01-10 00:51:23 +01001133static int arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001134{
Jessica Yu12310e342018-01-10 00:51:23 +01001135 if (unlikely(kprobe_ftrace(kp)))
1136 return arm_kprobe_ftrace(kp);
1137
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001138 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001139 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001140 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001141 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001142 cpus_read_unlock();
Jessica Yu12310e342018-01-10 00:51:23 +01001143
1144 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001145}
1146
1147/* Disarm a kprobe with text_mutex */
Jessica Yu297f9232018-01-10 00:51:24 +01001148static int disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001149{
Jessica Yu297f9232018-01-10 00:51:24 +01001150 if (unlikely(kprobe_ftrace(kp)))
1151 return disarm_kprobe_ftrace(kp);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001152
1153 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001154 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001155 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001156 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001157 cpus_read_unlock();
Jessica Yu297f9232018-01-10 00:51:24 +01001158
1159 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001160}
1161
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001162/*
1163 * Aggregate handlers for multiple kprobes support - these handlers
1164 * take care of invoking the individual kprobe handlers on p->list
1165 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001166static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001167{
1168 struct kprobe *kp;
1169
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001170 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001171 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001172 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001173 if (kp->pre_handler(kp, regs))
1174 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001175 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001176 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001177 }
1178 return 0;
1179}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001180NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001181
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001182static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1183 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001184{
1185 struct kprobe *kp;
1186
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001187 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001188 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001189 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001190 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001191 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001192 }
1193 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001194}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001195NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001196
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001197/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001198void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001199{
1200 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001201 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001202 p->nmissed++;
1203 } else {
1204 list_for_each_entry_rcu(kp, &p->list, list)
1205 kp->nmissed++;
1206 }
1207 return;
1208}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001209NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001210
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001211static void free_rp_inst_rcu(struct rcu_head *head)
1212{
1213 struct kretprobe_instance *ri = container_of(head, struct kretprobe_instance, rcu);
1214
1215 if (refcount_dec_and_test(&ri->rph->ref))
1216 kfree(ri->rph);
1217 kfree(ri);
1218}
1219NOKPROBE_SYMBOL(free_rp_inst_rcu);
1220
Masami Hiramatsub3388172020-08-29 22:02:47 +09001221static void recycle_rp_inst(struct kretprobe_instance *ri)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001222{
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001223 struct kretprobe *rp = get_kretprobe(ri);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001224
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001225 if (likely(rp)) {
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001226 freelist_add(&ri->freelist, &rp->freelist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001227 } else
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001228 call_rcu(&ri->rcu, free_rp_inst_rcu);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001229}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001230NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001231
Masami Hiramatsu319f0ce2020-08-29 22:03:02 +09001232static struct kprobe kprobe_busy = {
Jiri Olsa9b38cc72020-05-12 17:03:18 +09001233 .addr = (void *) get_kprobe,
1234};
1235
1236void kprobe_busy_begin(void)
1237{
1238 struct kprobe_ctlblk *kcb;
1239
1240 preempt_disable();
1241 __this_cpu_write(current_kprobe, &kprobe_busy);
1242 kcb = get_kprobe_ctlblk();
1243 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1244}
1245
1246void kprobe_busy_end(void)
1247{
1248 __this_cpu_write(current_kprobe, NULL);
1249 preempt_enable();
1250}
1251
Hien Nguyenb94cce92005-06-23 00:09:19 -07001252/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001253 * This function is called from finish_task_switch when task tk becomes dead,
1254 * so that we can recycle any function-return probe instances associated
1255 * with this task. These left over instances represent probed functions
1256 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001257 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001258void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001259{
bibo,mao62c27be2006-10-02 02:17:33 -07001260 struct kretprobe_instance *ri;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001261 struct llist_node *node;
Rusty Lynch802eae72005-06-27 15:17:08 -07001262
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001263 /* Early boot, not yet initialized. */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001264 if (unlikely(!kprobes_initialized))
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001265 return;
1266
Jiri Olsa9b38cc72020-05-12 17:03:18 +09001267 kprobe_busy_begin();
1268
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001269 node = __llist_del_all(&tk->kretprobe_instances);
1270 while (node) {
1271 ri = container_of(node, struct kretprobe_instance, llist);
1272 node = node->next;
1273
1274 recycle_rp_inst(ri);
bibo,mao62c27be2006-10-02 02:17:33 -07001275 }
Jiri Olsa9b38cc72020-05-12 17:03:18 +09001276
1277 kprobe_busy_end();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001278}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001279NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001280
Hien Nguyenb94cce92005-06-23 00:09:19 -07001281static inline void free_rp_inst(struct kretprobe *rp)
1282{
1283 struct kretprobe_instance *ri;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001284 struct freelist_node *node;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001285 int count = 0;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001286
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001287 node = rp->freelist.head;
1288 while (node) {
1289 ri = container_of(node, struct kretprobe_instance, freelist);
1290 node = node->next;
1291
Hien Nguyenb94cce92005-06-23 00:09:19 -07001292 kfree(ri);
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001293 count++;
1294 }
1295
1296 if (refcount_sub_and_test(count, &rp->rph->ref)) {
1297 kfree(rp->rph);
1298 rp->rph = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001299 }
1300}
1301
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001302/* Add the new probe to ap->list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001303static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001304{
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001305 if (p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001306 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001307
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001308 list_add_rcu(&p->list, &ap->list);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001309 if (p->post_handler && !ap->post_handler)
1310 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001311
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001312 return 0;
1313}
1314
1315/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001316 * Fill in the required fields of the "manager kprobe". Replace the
1317 * earlier kprobe in the hlist with the manager kprobe
1318 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001319static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001320{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001321 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001322 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001323 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001324 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001325 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001326 ap->pre_handler = aggr_pre_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001327 /* We don't care the kprobe which has gone. */
1328 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001329 ap->post_handler = aggr_post_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001330
1331 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001332 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001333
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001334 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001335 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001336}
1337
1338/*
1339 * This is the second or subsequent kprobe at the address - handle
1340 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001341 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001342static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001343{
1344 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001345 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001346
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001347 cpus_read_lock();
1348
Masami Hiramatsu25764282012-06-05 19:28:26 +09001349 /* For preparing optimization, jump_label_text_reserved() is called */
1350 jump_label_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001351 mutex_lock(&text_mutex);
1352
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001353 if (!kprobe_aggrprobe(orig_p)) {
1354 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1355 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001356 if (!ap) {
1357 ret = -ENOMEM;
1358 goto out;
1359 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001360 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001361 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001362 /* This probe is going to die. Rescue it */
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001363 ret = reuse_unused_kprobe(ap);
1364 if (ret)
1365 goto out;
1366 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001367
1368 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001369 /*
1370 * Attempting to insert new probe at the same location that
1371 * had a probe in the module vaddr area which already
1372 * freed. So, the instruction slot has already been
1373 * released. We need a new slot for the new probe.
1374 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001375 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001376 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001377 /*
1378 * Even if fail to allocate new slot, don't need to
1379 * free aggr_probe. It will be used next time, or
1380 * freed by unregister_kprobe.
1381 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001382 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001383
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001384 /* Prepare optimized instructions if possible. */
1385 prepare_optimized_kprobe(ap);
1386
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001387 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001388 * Clear gone flag to prevent allocating new slot again, and
1389 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001390 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001391 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1392 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001393 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001394
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001395 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001396 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001397 ret = add_new_kprobe(ap, p);
1398
1399out:
1400 mutex_unlock(&text_mutex);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001401 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001402 cpus_read_unlock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001403
1404 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1405 ap->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01001406 if (!kprobes_all_disarmed) {
Masami Hiramatsu25764282012-06-05 19:28:26 +09001407 /* Arm the breakpoint again. */
Jessica Yu12310e342018-01-10 00:51:23 +01001408 ret = arm_kprobe(ap);
1409 if (ret) {
1410 ap->flags |= KPROBE_FLAG_DISABLED;
1411 list_del_rcu(&p->list);
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001412 synchronize_rcu();
Jessica Yu12310e342018-01-10 00:51:23 +01001413 }
1414 }
Masami Hiramatsu25764282012-06-05 19:28:26 +09001415 }
1416 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001417}
1418
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001419bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1420{
1421 /* The __kprobes marked functions and entry code must not be probed */
1422 return addr >= (unsigned long)__kprobes_text_start &&
1423 addr < (unsigned long)__kprobes_text_end;
1424}
1425
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001426static bool __within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001427{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001428 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001429
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001430 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001431 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001432 /*
1433 * If there exists a kprobe_blacklist, verify and
1434 * fail any probe registration in the prohibited area
1435 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001436 list_for_each_entry(ent, &kprobe_blacklist, list) {
1437 if (addr >= ent->start_addr && addr < ent->end_addr)
1438 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001439 }
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001440 return false;
1441}
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001442
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001443bool within_kprobe_blacklist(unsigned long addr)
1444{
1445 char symname[KSYM_NAME_LEN], *p;
1446
1447 if (__within_kprobe_blacklist(addr))
1448 return true;
1449
1450 /* Check if the address is on a suffixed-symbol */
1451 if (!lookup_symbol_name(addr, symname)) {
1452 p = strchr(symname, '.');
1453 if (!p)
1454 return false;
1455 *p = '\0';
1456 addr = (unsigned long)kprobe_lookup_name(symname, 0);
1457 if (addr)
1458 return __within_kprobe_blacklist(addr);
1459 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001460 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001461}
1462
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001463/*
1464 * If we have a symbol_name argument, look it up and add the offset field
1465 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001466 * This returns encoded errors if it fails to look up symbol or invalid
1467 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001468 */
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301469static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1470 const char *symbol_name, unsigned int offset)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001471{
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301472 if ((symbol_name && addr) || (!symbol_name && !addr))
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001473 goto invalid;
1474
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301475 if (symbol_name) {
Linus Torvalds7246f602017-05-05 11:36:44 -07001476 addr = kprobe_lookup_name(symbol_name, offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001477 if (!addr)
1478 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001479 }
1480
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301481 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001482 if (addr)
1483 return addr;
1484
1485invalid:
1486 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001487}
1488
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301489static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1490{
1491 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1492}
1493
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301494/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001495static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301496{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001497 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301498
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001499 lockdep_assert_held(&kprobe_mutex);
1500
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001501 ap = get_kprobe(p->addr);
1502 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301503 return NULL;
1504
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001505 if (p != ap) {
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001506 list_for_each_entry(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301507 if (list_p == p)
1508 /* kprobe p is a valid probe */
1509 goto valid;
1510 return NULL;
1511 }
1512valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001513 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301514}
1515
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001516/*
1517 * Warn and return error if the kprobe is being re-registered since
1518 * there must be a software bug.
1519 */
1520static inline int warn_kprobe_rereg(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301521{
1522 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301523
1524 mutex_lock(&kprobe_mutex);
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001525 if (WARN_ON_ONCE(__get_valid_kprobe(p)))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301526 ret = -EINVAL;
1527 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001528
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301529 return ret;
1530}
1531
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001532int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001534 unsigned long ftrace_addr;
1535
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001536 ftrace_addr = ftrace_location((unsigned long)p->addr);
1537 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001538#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001539 /* Given address is not on the instruction boundary */
1540 if ((unsigned long)p->addr != ftrace_addr)
1541 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001542 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001543#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001544 return -EINVAL;
1545#endif
1546 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001547 return 0;
1548}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001549
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001550static int check_kprobe_address_safe(struct kprobe *p,
1551 struct module **probed_mod)
1552{
1553 int ret;
1554
1555 ret = arch_check_ftrace_location(p);
1556 if (ret)
1557 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001558 jump_label_lock();
1559 preempt_disable();
1560
1561 /* Ensure it is not in reserved area nor out of text */
1562 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001563 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsue336b402019-09-03 20:08:21 +09001564 jump_label_text_reserved(p->addr, p->addr) ||
Peter Zijlstrafa68bd02021-06-28 13:24:12 +02001565 static_call_text_reserved(p->addr, p->addr) ||
Masami Hiramatsue336b402019-09-03 20:08:21 +09001566 find_bug((unsigned long)p->addr)) {
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001567 ret = -EINVAL;
1568 goto out;
1569 }
1570
1571 /* Check if are we probing a module */
1572 *probed_mod = __module_text_address((unsigned long) p->addr);
1573 if (*probed_mod) {
1574 /*
1575 * We must hold a refcount of the probed module while updating
1576 * its code to prohibit unexpected unloading.
1577 */
1578 if (unlikely(!try_module_get(*probed_mod))) {
1579 ret = -ENOENT;
1580 goto out;
1581 }
1582
1583 /*
1584 * If the module freed .init.text, we couldn't insert
1585 * kprobes in there.
1586 */
1587 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1588 (*probed_mod)->state != MODULE_STATE_COMING) {
1589 module_put(*probed_mod);
1590 *probed_mod = NULL;
1591 ret = -ENOENT;
1592 }
1593 }
1594out:
1595 preempt_enable();
1596 jump_label_unlock();
1597
1598 return ret;
1599}
1600
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001601int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001602{
1603 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001604 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001605 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001606 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001608 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001609 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001610 if (IS_ERR(addr))
1611 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001612 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001613
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001614 ret = warn_kprobe_rereg(p);
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301615 if (ret)
1616 return ret;
1617
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001618 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1619 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001620 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001621 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001622
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001623 ret = check_kprobe_address_safe(p, &probed_mod);
1624 if (ret)
1625 return ret;
1626
1627 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001628
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001629 old_p = get_kprobe(p->addr);
1630 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001631 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001632 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 goto out;
1634 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001636 cpus_read_lock();
1637 /* Prevent text modification */
1638 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001639 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001640 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001641 cpus_read_unlock();
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001642 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001643 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001644
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001645 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001646 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1648
Jessica Yu12310e342018-01-10 00:51:23 +01001649 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1650 ret = arm_kprobe(p);
1651 if (ret) {
1652 hlist_del_rcu(&p->hlist);
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001653 synchronize_rcu();
Jessica Yu12310e342018-01-10 00:51:23 +01001654 goto out;
1655 }
1656 }
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001657
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001658 /* Try to optimize kprobe */
1659 try_to_optimize_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001661 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001662
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001663 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001664 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001665
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 return ret;
1667}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001668EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001670/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001671static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001672{
1673 struct kprobe *kp;
1674
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001675 lockdep_assert_held(&kprobe_mutex);
1676
1677 list_for_each_entry(kp, &ap->list, list)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001678 if (!kprobe_disabled(kp))
1679 /*
1680 * There is an active probe on the list.
1681 * We can't disable this ap.
1682 */
1683 return 0;
1684
1685 return 1;
1686}
1687
1688/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001689static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001690{
1691 struct kprobe *orig_p;
Jessica Yu297f9232018-01-10 00:51:24 +01001692 int ret;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001693
1694 /* Get an original kprobe for return */
1695 orig_p = __get_valid_kprobe(p);
1696 if (unlikely(orig_p == NULL))
Jessica Yu297f9232018-01-10 00:51:24 +01001697 return ERR_PTR(-EINVAL);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001698
1699 if (!kprobe_disabled(p)) {
1700 /* Disable probe if it is a child probe */
1701 if (p != orig_p)
1702 p->flags |= KPROBE_FLAG_DISABLED;
1703
1704 /* Try to disarm and disable this/parent probe */
1705 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001706 /*
1707 * If kprobes_all_disarmed is set, orig_p
1708 * should have already been disarmed, so
1709 * skip unneed disarming process.
1710 */
Jessica Yu297f9232018-01-10 00:51:24 +01001711 if (!kprobes_all_disarmed) {
1712 ret = disarm_kprobe(orig_p, true);
1713 if (ret) {
1714 p->flags &= ~KPROBE_FLAG_DISABLED;
1715 return ERR_PTR(ret);
1716 }
1717 }
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001718 orig_p->flags |= KPROBE_FLAG_DISABLED;
1719 }
1720 }
1721
1722 return orig_p;
1723}
1724
Masami Hiramatsu98616682008-04-28 02:14:28 -07001725/*
1726 * Unregister a kprobe without a scheduler synchronization.
1727 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001728static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001729{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001730 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001731
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001732 /* Disable kprobe. This will disarm it if needed. */
1733 ap = __disable_kprobe(p);
Jessica Yu297f9232018-01-10 00:51:24 +01001734 if (IS_ERR(ap))
1735 return PTR_ERR(ap);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001736
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001737 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001738 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001739 * This probe is an independent(and non-optimized) kprobe
1740 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001741 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001742 goto disarmed;
1743
1744 /* Following process expects this probe is an aggrprobe */
1745 WARN_ON(!kprobe_aggrprobe(ap));
1746
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001747 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1748 /*
1749 * !disarmed could be happen if the probe is under delayed
1750 * unoptimizing.
1751 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001752 goto disarmed;
1753 else {
1754 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001755 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001756 list_for_each_entry(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001757 if ((list_p != p) && (list_p->post_handler))
1758 goto noclean;
1759 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001760 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001761 }
1762noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001763 /*
1764 * Remove from the aggrprobe: this path will do nothing in
1765 * __unregister_kprobe_bottom().
1766 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001767 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001768 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1769 /*
1770 * Try to optimize this probe again, because post
1771 * handler may have been changed.
1772 */
1773 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001774 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001775 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001776
1777disarmed:
1778 hlist_del_rcu(&ap->hlist);
1779 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001780}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001781
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001782static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001783{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001784 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001785
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001786 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001787 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001788 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001789 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001790 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001791 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001792 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001793 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001794 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001795 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796}
1797
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001798int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001799{
1800 int i, ret = 0;
1801
1802 if (num <= 0)
1803 return -EINVAL;
1804 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001805 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001806 if (ret < 0) {
1807 if (i > 0)
1808 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001809 break;
1810 }
1811 }
1812 return ret;
1813}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001814EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001815
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001816void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001817{
1818 unregister_kprobes(&p, 1);
1819}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001820EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001821
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001822void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001823{
1824 int i;
1825
1826 if (num <= 0)
1827 return;
1828 mutex_lock(&kprobe_mutex);
1829 for (i = 0; i < num; i++)
1830 if (__unregister_kprobe_top(kps[i]) < 0)
1831 kps[i]->addr = NULL;
1832 mutex_unlock(&kprobe_mutex);
1833
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001834 synchronize_rcu();
Masami Hiramatsu98616682008-04-28 02:14:28 -07001835 for (i = 0; i < num; i++)
1836 if (kps[i]->addr)
1837 __unregister_kprobe_bottom(kps[i]);
1838}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001839EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001840
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301841int __weak kprobe_exceptions_notify(struct notifier_block *self,
1842 unsigned long val, void *data)
Naveen N. Raofc62d022017-02-08 01:24:14 +05301843{
1844 return NOTIFY_DONE;
1845}
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301846NOKPROBE_SYMBOL(kprobe_exceptions_notify);
Naveen N. Raofc62d022017-02-08 01:24:14 +05301847
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848static struct notifier_block kprobe_exceptions_nb = {
1849 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001850 .priority = 0x7fffffff /* we need to be notified first */
1851};
1852
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001853unsigned long __weak arch_deref_entry_point(void *entry)
1854{
1855 return (unsigned long)entry;
1856}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001858#ifdef CONFIG_KRETPROBES
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001859
1860unsigned long __kretprobe_trampoline_handler(struct pt_regs *regs,
1861 void *trampoline_address,
1862 void *frame_pointer)
1863{
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001864 kprobe_opcode_t *correct_ret_addr = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001865 struct kretprobe_instance *ri = NULL;
1866 struct llist_node *first, *node;
1867 struct kretprobe *rp;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001868
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001869 /* Find all nodes for this frame. */
1870 first = node = current->kretprobe_instances.first;
1871 while (node) {
1872 ri = container_of(node, struct kretprobe_instance, llist);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001873
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001874 BUG_ON(ri->fp != frame_pointer);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001875
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001876 if (ri->ret_addr != trampoline_address) {
1877 correct_ret_addr = ri->ret_addr;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001878 /*
1879 * This is the real return address. Any other
1880 * instances associated with this task are for
1881 * other calls deeper on the call stack
1882 */
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001883 goto found;
1884 }
1885
1886 node = node->next;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001887 }
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001888 pr_err("Oops! Kretprobe fails to find correct return address.\n");
1889 BUG_ON(1);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001890
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001891found:
1892 /* Unlink all nodes for this frame. */
1893 current->kretprobe_instances.first = node->next;
1894 node->next = NULL;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001895
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001896 /* Run them.. */
1897 while (first) {
1898 ri = container_of(first, struct kretprobe_instance, llist);
1899 first = first->next;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001900
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001901 rp = get_kretprobe(ri);
1902 if (rp && rp->handler) {
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001903 struct kprobe *prev = kprobe_running();
1904
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001905 __this_cpu_write(current_kprobe, &rp->kp);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001906 ri->ret_addr = correct_ret_addr;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001907 rp->handler(ri, regs);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001908 __this_cpu_write(current_kprobe, prev);
1909 }
1910
Masami Hiramatsub3388172020-08-29 22:02:47 +09001911 recycle_rp_inst(ri);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001912 }
1913
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001914 return (unsigned long)correct_ret_addr;
1915}
1916NOKPROBE_SYMBOL(__kretprobe_trampoline_handler)
1917
Adrian Bunke65cefe2006-02-03 03:03:42 -08001918/*
1919 * This kprobe pre_handler is registered with every kretprobe. When probe
1920 * hits it will set up the return probe.
1921 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001922static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001923{
1924 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001925 struct kretprobe_instance *ri;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001926 struct freelist_node *fn;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001927
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001928 fn = freelist_try_get(&rp->freelist);
1929 if (!fn) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001930 rp->nmissed++;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001931 return 0;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001932 }
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001933
1934 ri = container_of(fn, struct kretprobe_instance, freelist);
1935
1936 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1937 freelist_add(&ri->freelist, &rp->freelist);
1938 return 0;
1939 }
1940
1941 arch_prepare_kretprobe(ri, regs);
1942
1943 __llist_add(&ri->llist, &current->kretprobe_instances);
1944
Adrian Bunke65cefe2006-02-03 03:03:42 -08001945 return 0;
1946}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001947NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001948
Naveen N. Rao659b9572017-07-07 22:37:24 +05301949bool __weak arch_kprobe_on_func_entry(unsigned long offset)
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301950{
1951 return !offset;
1952}
1953
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09001954/**
1955 * kprobe_on_func_entry() -- check whether given address is function entry
1956 * @addr: Target address
1957 * @sym: Target symbol name
1958 * @offset: The offset from the symbol or the address
1959 *
1960 * This checks whether the given @addr+@offset or @sym+@offset is on the
1961 * function entry address or not.
1962 * This returns 0 if it is the function entry, or -EINVAL if it is not.
1963 * And also it returns -ENOENT if it fails the symbol or address lookup.
1964 * Caller must pass @addr or @sym (either one must be NULL), or this
1965 * returns -EINVAL.
1966 */
1967int kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301968{
1969 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1970
1971 if (IS_ERR(kp_addr))
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09001972 return PTR_ERR(kp_addr);
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301973
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09001974 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset))
1975 return -ENOENT;
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301976
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09001977 if (!arch_kprobe_on_func_entry(offset))
1978 return -EINVAL;
1979
1980 return 0;
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301981}
1982
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001983int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001984{
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09001985 int ret;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001986 struct kretprobe_instance *inst;
1987 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001988 void *addr;
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301989
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09001990 ret = kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset);
1991 if (ret)
1992 return ret;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001993
Wang ShaoBo0188b872021-01-28 20:44:27 +08001994 /* If only rp->kp.addr is specified, check reregistering kprobes */
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001995 if (rp->kp.addr && warn_kprobe_rereg(&rp->kp))
Wang ShaoBo0188b872021-01-28 20:44:27 +08001996 return -EINVAL;
1997
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001998 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001999 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09002000 if (IS_ERR(addr))
2001 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002002
2003 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2004 if (kretprobe_blacklist[i].addr == addr)
2005 return -EINVAL;
2006 }
2007 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07002008
2009 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07002010 rp->kp.post_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07002011
2012 /* Pre-allocate memory for max kretprobe instances */
2013 if (rp->maxactive <= 0) {
Thomas Gleixner92616602019-07-26 23:19:41 +02002014#ifdef CONFIG_PREEMPTION
Heiko Carstensc2ef6662009-12-21 13:02:24 +01002015 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07002016#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05302017 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07002018#endif
2019 }
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002020 rp->freelist.head = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002021 rp->rph = kzalloc(sizeof(struct kretprobe_holder), GFP_KERNEL);
2022 if (!rp->rph)
2023 return -ENOMEM;
2024
2025 rp->rph->rp = rp;
Hien Nguyenb94cce92005-06-23 00:09:19 -07002026 for (i = 0; i < rp->maxactive; i++) {
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002027 inst = kzalloc(sizeof(struct kretprobe_instance) +
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08002028 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002029 if (inst == NULL) {
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002030 refcount_set(&rp->rph->ref, i);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002031 free_rp_inst(rp);
2032 return -ENOMEM;
2033 }
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002034 inst->rph = rp->rph;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002035 freelist_add(&inst->freelist, &rp->freelist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002036 }
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002037 refcount_set(&rp->rph->ref, i);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002038
2039 rp->nmissed = 0;
2040 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08002041 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002042 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002043 free_rp_inst(rp);
2044 return ret;
2045}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002046EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002047
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002048int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002049{
2050 int ret = 0, i;
2051
2052 if (num <= 0)
2053 return -EINVAL;
2054 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08002055 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07002056 if (ret < 0) {
2057 if (i > 0)
2058 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002059 break;
2060 }
2061 }
2062 return ret;
2063}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002064EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002065
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002066void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002067{
2068 unregister_kretprobes(&rp, 1);
2069}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002070EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002071
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002072void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002073{
2074 int i;
2075
2076 if (num <= 0)
2077 return;
2078 mutex_lock(&kprobe_mutex);
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002079 for (i = 0; i < num; i++) {
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002080 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2081 rps[i]->kp.addr = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002082 rps[i]->rph->rp = NULL;
2083 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002084 mutex_unlock(&kprobe_mutex);
2085
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08002086 synchronize_rcu();
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002087 for (i = 0; i < num; i++) {
2088 if (rps[i]->kp.addr) {
2089 __unregister_kprobe_bottom(&rps[i]->kp);
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002090 free_rp_inst(rps[i]);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002091 }
2092 }
2093}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002094EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002095
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002096#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002097int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002098{
2099 return -ENOSYS;
2100}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002101EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002102
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002103int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002104{
2105 return -ENOSYS;
2106}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002107EXPORT_SYMBOL_GPL(register_kretprobes);
2108
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002109void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002110{
2111}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002112EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002113
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002114void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002115{
2116}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002117EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002118
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002119static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002120{
2121 return 0;
2122}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002123NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002124
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002125#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002126
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002127/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002128static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002129{
2130 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002131
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002132 lockdep_assert_held(&kprobe_mutex);
2133
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002134 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002135 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002136 /*
2137 * If this is an aggr_kprobe, we have to list all the
2138 * chained probes and mark them GONE.
2139 */
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002140 list_for_each_entry(kp, &p->list, list)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002141 kp->flags |= KPROBE_FLAG_GONE;
2142 p->post_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002143 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002144 }
2145 /*
2146 * Here, we can remove insn_slot safely, because no thread calls
2147 * the original probed function (which will be freed soon) any more.
2148 */
2149 arch_remove_kprobe(p);
Muchun Song0cb2f132020-07-28 14:45:36 +08002150
2151 /*
2152 * The module is going away. We should disarm the kprobe which
Masami Hiramatsubcb53202020-09-01 00:12:07 +09002153 * is using ftrace, because ftrace framework is still available at
2154 * MODULE_STATE_GOING notification.
Muchun Song0cb2f132020-07-28 14:45:36 +08002155 */
Masami Hiramatsubcb53202020-09-01 00:12:07 +09002156 if (kprobe_ftrace(p) && !kprobe_disabled(p) && !kprobes_all_disarmed)
Muchun Song0cb2f132020-07-28 14:45:36 +08002157 disarm_kprobe_ftrace(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002158}
2159
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002160/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002161int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002162{
2163 int ret = 0;
Jessica Yu297f9232018-01-10 00:51:24 +01002164 struct kprobe *p;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002165
2166 mutex_lock(&kprobe_mutex);
2167
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002168 /* Disable this kprobe */
Jessica Yu297f9232018-01-10 00:51:24 +01002169 p = __disable_kprobe(kp);
2170 if (IS_ERR(p))
2171 ret = PTR_ERR(p);
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002172
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002173 mutex_unlock(&kprobe_mutex);
2174 return ret;
2175}
2176EXPORT_SYMBOL_GPL(disable_kprobe);
2177
2178/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002179int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002180{
2181 int ret = 0;
2182 struct kprobe *p;
2183
2184 mutex_lock(&kprobe_mutex);
2185
2186 /* Check whether specified probe is valid. */
2187 p = __get_valid_kprobe(kp);
2188 if (unlikely(p == NULL)) {
2189 ret = -EINVAL;
2190 goto out;
2191 }
2192
2193 if (kprobe_gone(kp)) {
2194 /* This kprobe has gone, we couldn't enable it. */
2195 ret = -EINVAL;
2196 goto out;
2197 }
2198
2199 if (p != kp)
2200 kp->flags &= ~KPROBE_FLAG_DISABLED;
2201
2202 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2203 p->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01002204 ret = arm_kprobe(p);
2205 if (ret)
2206 p->flags |= KPROBE_FLAG_DISABLED;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002207 }
2208out:
2209 mutex_unlock(&kprobe_mutex);
2210 return ret;
2211}
2212EXPORT_SYMBOL_GPL(enable_kprobe);
2213
Masami Hiramatsu44585152018-04-28 21:36:33 +09002214/* Caller must NOT call this in usual path. This is only for critical case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002215void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002216{
Masami Hiramatsu44585152018-04-28 21:36:33 +09002217 pr_err("Dumping kprobe:\n");
2218 pr_err("Name: %s\nOffset: %x\nAddress: %pS\n",
2219 kp->symbol_name, kp->offset, kp->addr);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002220}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002221NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002222
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002223int kprobe_add_ksym_blacklist(unsigned long entry)
2224{
2225 struct kprobe_blacklist_entry *ent;
2226 unsigned long offset = 0, size = 0;
2227
2228 if (!kernel_text_address(entry) ||
2229 !kallsyms_lookup_size_offset(entry, &size, &offset))
2230 return -EINVAL;
2231
2232 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2233 if (!ent)
2234 return -ENOMEM;
2235 ent->start_addr = entry;
2236 ent->end_addr = entry + size;
2237 INIT_LIST_HEAD(&ent->list);
2238 list_add_tail(&ent->list, &kprobe_blacklist);
2239
2240 return (int)size;
2241}
2242
2243/* Add all symbols in given area into kprobe blacklist */
2244int kprobe_add_area_blacklist(unsigned long start, unsigned long end)
2245{
2246 unsigned long entry;
2247 int ret = 0;
2248
2249 for (entry = start; entry < end; entry += ret) {
2250 ret = kprobe_add_ksym_blacklist(entry);
2251 if (ret < 0)
2252 return ret;
2253 if (ret == 0) /* In case of alias symbol */
2254 ret = 1;
2255 }
2256 return 0;
2257}
2258
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002259/* Remove all symbols in given area from kprobe blacklist */
2260static void kprobe_remove_area_blacklist(unsigned long start, unsigned long end)
2261{
2262 struct kprobe_blacklist_entry *ent, *n;
2263
2264 list_for_each_entry_safe(ent, n, &kprobe_blacklist, list) {
2265 if (ent->start_addr < start || ent->start_addr >= end)
2266 continue;
2267 list_del(&ent->list);
2268 kfree(ent);
2269 }
2270}
2271
Masami Hiramatsu16db6262020-03-26 23:50:00 +09002272static void kprobe_remove_ksym_blacklist(unsigned long entry)
2273{
2274 kprobe_remove_area_blacklist(entry, entry + 1);
2275}
2276
Adrian Hunterd002b8b2020-05-28 11:00:58 +03002277int __weak arch_kprobe_get_kallsym(unsigned int *symnum, unsigned long *value,
2278 char *type, char *sym)
2279{
2280 return -ERANGE;
2281}
2282
2283int kprobe_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
2284 char *sym)
2285{
2286#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
2287 if (!kprobe_cache_get_kallsym(&kprobe_insn_slots, &symnum, value, type, sym))
2288 return 0;
2289#ifdef CONFIG_OPTPROBES
2290 if (!kprobe_cache_get_kallsym(&kprobe_optinsn_slots, &symnum, value, type, sym))
2291 return 0;
2292#endif
2293#endif
2294 if (!arch_kprobe_get_kallsym(&symnum, value, type, sym))
2295 return 0;
2296 return -ERANGE;
2297}
2298
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002299int __init __weak arch_populate_kprobe_blacklist(void)
2300{
2301 return 0;
2302}
2303
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002304/*
2305 * Lookup and populate the kprobe_blacklist.
2306 *
2307 * Unlike the kretprobe blacklist, we'll need to determine
2308 * the range of addresses that belong to the said functions,
2309 * since a kprobe need not necessarily be at the beginning
2310 * of a function.
2311 */
2312static int __init populate_kprobe_blacklist(unsigned long *start,
2313 unsigned long *end)
2314{
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002315 unsigned long entry;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002316 unsigned long *iter;
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002317 int ret;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002318
2319 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002320 entry = arch_deref_entry_point((void *)*iter);
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002321 ret = kprobe_add_ksym_blacklist(entry);
2322 if (ret == -EINVAL)
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002323 continue;
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002324 if (ret < 0)
2325 return ret;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002326 }
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002327
2328 /* Symbols in __kprobes_text are blacklisted */
2329 ret = kprobe_add_area_blacklist((unsigned long)__kprobes_text_start,
2330 (unsigned long)__kprobes_text_end);
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002331 if (ret)
2332 return ret;
2333
2334 /* Symbols in noinstr section are blacklisted */
2335 ret = kprobe_add_area_blacklist((unsigned long)__noinstr_text_start,
2336 (unsigned long)__noinstr_text_end);
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002337
2338 return ret ? : arch_populate_kprobe_blacklist();
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002339}
2340
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002341static void add_module_kprobe_blacklist(struct module *mod)
2342{
2343 unsigned long start, end;
Masami Hiramatsu16db6262020-03-26 23:50:00 +09002344 int i;
2345
2346 if (mod->kprobe_blacklist) {
2347 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2348 kprobe_add_ksym_blacklist(mod->kprobe_blacklist[i]);
2349 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002350
2351 start = (unsigned long)mod->kprobes_text_start;
2352 if (start) {
2353 end = start + mod->kprobes_text_size;
2354 kprobe_add_area_blacklist(start, end);
2355 }
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002356
2357 start = (unsigned long)mod->noinstr_text_start;
2358 if (start) {
2359 end = start + mod->noinstr_text_size;
2360 kprobe_add_area_blacklist(start, end);
2361 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002362}
2363
2364static void remove_module_kprobe_blacklist(struct module *mod)
2365{
2366 unsigned long start, end;
Masami Hiramatsu16db6262020-03-26 23:50:00 +09002367 int i;
2368
2369 if (mod->kprobe_blacklist) {
2370 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2371 kprobe_remove_ksym_blacklist(mod->kprobe_blacklist[i]);
2372 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002373
2374 start = (unsigned long)mod->kprobes_text_start;
2375 if (start) {
2376 end = start + mod->kprobes_text_size;
2377 kprobe_remove_area_blacklist(start, end);
2378 }
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002379
2380 start = (unsigned long)mod->noinstr_text_start;
2381 if (start) {
2382 end = start + mod->noinstr_text_size;
2383 kprobe_remove_area_blacklist(start, end);
2384 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002385}
2386
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002387/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002388static int kprobes_module_callback(struct notifier_block *nb,
2389 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002390{
2391 struct module *mod = data;
2392 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002393 struct kprobe *p;
2394 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002395 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002396
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002397 if (val == MODULE_STATE_COMING) {
2398 mutex_lock(&kprobe_mutex);
2399 add_module_kprobe_blacklist(mod);
2400 mutex_unlock(&kprobe_mutex);
2401 }
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002402 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002403 return NOTIFY_DONE;
2404
2405 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002406 * When MODULE_STATE_GOING was notified, both of module .text and
2407 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2408 * notified, only .init.text section would be freed. We need to
2409 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002410 */
2411 mutex_lock(&kprobe_mutex);
2412 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2413 head = &kprobe_table[i];
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002414 hlist_for_each_entry(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002415 if (within_module_init((unsigned long)p->addr, mod) ||
2416 (checkcore &&
2417 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002418 /*
2419 * The vaddr this probe is installed will soon
2420 * be vfreed buy not synced to disk. Hence,
2421 * disarming the breakpoint isn't needed.
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002422 *
2423 * Note, this will also move any optimized probes
2424 * that are pending to be removed from their
2425 * corresponding lists to the freeing_list and
2426 * will not be touched by the delayed
2427 * kprobe_optimizer work handler.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002428 */
2429 kill_kprobe(p);
2430 }
2431 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002432 if (val == MODULE_STATE_GOING)
2433 remove_module_kprobe_blacklist(mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002434 mutex_unlock(&kprobe_mutex);
2435 return NOTIFY_DONE;
2436}
2437
2438static struct notifier_block kprobe_module_nb = {
2439 .notifier_call = kprobes_module_callback,
2440 .priority = 0
2441};
2442
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002443/* Markers of _kprobe_blacklist section */
2444extern unsigned long __start_kprobe_blacklist[];
2445extern unsigned long __stop_kprobe_blacklist[];
2446
Masami Hiramatsu82d083a2020-09-10 17:55:05 +09002447void kprobe_free_init_mem(void)
2448{
2449 void *start = (void *)(&__init_begin);
2450 void *end = (void *)(&__init_end);
2451 struct hlist_head *head;
2452 struct kprobe *p;
2453 int i;
2454
2455 mutex_lock(&kprobe_mutex);
2456
2457 /* Kill all kprobes on initmem */
2458 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2459 head = &kprobe_table[i];
2460 hlist_for_each_entry(p, head, hlist) {
2461 if (start <= (void *)p->addr && (void *)p->addr < end)
2462 kill_kprobe(p);
2463 }
2464 }
2465
2466 mutex_unlock(&kprobe_mutex);
2467}
2468
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469static int __init init_kprobes(void)
2470{
2471 int i, err = 0;
2472
2473 /* FIXME allocate the probe table, currently defined statically */
2474 /* initialize all list heads */
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002475 for (i = 0; i < KPROBE_TABLE_SIZE; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 INIT_HLIST_HEAD(&kprobe_table[i]);
2477
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002478 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2479 __stop_kprobe_blacklist);
2480 if (err) {
2481 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2482 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002483 }
2484
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002485 if (kretprobe_blacklist_size) {
2486 /* lookup the function address from its name */
2487 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
Naveen N. Rao49e0b462017-04-19 18:21:00 +05302488 kretprobe_blacklist[i].addr =
Naveen N. Rao290e3072017-04-19 18:21:01 +05302489 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002490 if (!kretprobe_blacklist[i].addr)
2491 printk("kretprobe: lookup failed: %s\n",
2492 kretprobe_blacklist[i].name);
2493 }
2494 }
2495
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002496 /* By default, kprobes are armed */
2497 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002498
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +09002499#if defined(CONFIG_OPTPROBES) && defined(__ARCH_WANT_KPROBES_INSN_SLOT)
2500 /* Init kprobe_optinsn_slots for allocation */
2501 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2502#endif
2503
Rusty Lynch67729262005-07-05 18:54:50 -07002504 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002505 if (!err)
2506 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002507 if (!err)
2508 err = register_module_notifier(&kprobe_module_nb);
2509
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002510 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002511
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002512 if (!err)
2513 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 return err;
2515}
Masami Hiramatsu36dadef2020-09-10 21:38:39 +09002516early_initcall(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +09002518#if defined(CONFIG_OPTPROBES)
2519static int __init init_optprobes(void)
2520{
2521 /*
2522 * Enable kprobe optimization - this kicks the optimizer which
2523 * depends on synchronize_rcu_tasks() and ksoftirqd, that is
2524 * not spawned in early initcall. So delay the optimization.
2525 */
2526 optimize_all_kprobes();
2527
2528 return 0;
2529}
2530subsys_initcall(init_optprobes);
2531#endif
2532
Srinivasa Ds346fd592007-02-20 13:57:54 -08002533#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002534static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002535 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002536{
2537 char *kprobe_type;
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002538 void *addr = p->addr;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002539
2540 if (p->pre_handler == pre_handler_kretprobe)
2541 kprobe_type = "r";
Srinivasa Ds346fd592007-02-20 13:57:54 -08002542 else
2543 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002544
Kees Cook60f7bb62020-07-02 15:20:22 -07002545 if (!kallsyms_show_value(pi->file->f_cred))
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002546 addr = NULL;
2547
Srinivasa Ds346fd592007-02-20 13:57:54 -08002548 if (sym)
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002549 seq_printf(pi, "%px %s %s+0x%x %s ",
2550 addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002551 (modname ? modname : " "));
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002552 else /* try to use %pS */
2553 seq_printf(pi, "%px %s %pS ",
2554 addr, kprobe_type, p->addr);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002555
2556 if (!pp)
2557 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002558 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002559 (kprobe_gone(p) ? "[GONE]" : ""),
2560 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002561 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2562 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002563}
2564
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002565static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002566{
2567 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2568}
2569
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002570static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002571{
2572 (*pos)++;
2573 if (*pos >= KPROBE_TABLE_SIZE)
2574 return NULL;
2575 return pos;
2576}
2577
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002578static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002579{
2580 /* Nothing to do */
2581}
2582
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002583static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002584{
2585 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002586 struct kprobe *p, *kp;
2587 const char *sym = NULL;
2588 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002589 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002590 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002591
2592 head = &kprobe_table[i];
2593 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002594 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002595 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002596 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002597 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002598 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002599 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002600 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002601 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002602 }
2603 preempt_enable();
2604 return 0;
2605}
2606
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002607static const struct seq_operations kprobes_sops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002608 .start = kprobe_seq_start,
2609 .next = kprobe_seq_next,
2610 .stop = kprobe_seq_stop,
2611 .show = show_kprobe_addr
2612};
2613
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002614DEFINE_SEQ_ATTRIBUTE(kprobes);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002615
Masami Hiramatsu63724742014-04-17 17:18:49 +09002616/* kprobes/blacklist -- shows which functions can not be probed */
2617static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2618{
Masami Hiramatsu4fdd8882020-03-26 23:49:36 +09002619 mutex_lock(&kprobe_mutex);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002620 return seq_list_start(&kprobe_blacklist, *pos);
2621}
2622
2623static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2624{
2625 return seq_list_next(v, &kprobe_blacklist, pos);
2626}
2627
2628static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2629{
2630 struct kprobe_blacklist_entry *ent =
2631 list_entry(v, struct kprobe_blacklist_entry, list);
2632
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002633 /*
2634 * If /proc/kallsyms is not showing kernel address, we won't
2635 * show them here either.
2636 */
Kees Cook60f7bb62020-07-02 15:20:22 -07002637 if (!kallsyms_show_value(m->file->f_cred))
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002638 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2639 (void *)ent->start_addr);
2640 else
2641 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2642 (void *)ent->end_addr, (void *)ent->start_addr);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002643 return 0;
2644}
2645
Masami Hiramatsu4fdd8882020-03-26 23:49:36 +09002646static void kprobe_blacklist_seq_stop(struct seq_file *f, void *v)
2647{
2648 mutex_unlock(&kprobe_mutex);
2649}
2650
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002651static const struct seq_operations kprobe_blacklist_sops = {
Masami Hiramatsu63724742014-04-17 17:18:49 +09002652 .start = kprobe_blacklist_seq_start,
2653 .next = kprobe_blacklist_seq_next,
Masami Hiramatsu4fdd8882020-03-26 23:49:36 +09002654 .stop = kprobe_blacklist_seq_stop,
Masami Hiramatsu63724742014-04-17 17:18:49 +09002655 .show = kprobe_blacklist_seq_show,
2656};
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002657DEFINE_SEQ_ATTRIBUTE(kprobe_blacklist);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002658
Jessica Yu12310e342018-01-10 00:51:23 +01002659static int arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002660{
2661 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002662 struct kprobe *p;
Jessica Yu12310e342018-01-10 00:51:23 +01002663 unsigned int i, total = 0, errors = 0;
2664 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002665
2666 mutex_lock(&kprobe_mutex);
2667
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002668 /* If kprobes are armed, just return */
2669 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002670 goto already_enabled;
2671
Wang Nan977ad482015-02-13 14:40:24 -08002672 /*
2673 * optimize_kprobe() called by arm_kprobe() checks
2674 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2675 * arm_kprobe.
2676 */
2677 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002678 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002679 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2680 head = &kprobe_table[i];
Jessica Yu12310e342018-01-10 00:51:23 +01002681 /* Arm all kprobes on a best-effort basis */
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002682 hlist_for_each_entry(p, head, hlist) {
Jessica Yu12310e342018-01-10 00:51:23 +01002683 if (!kprobe_disabled(p)) {
2684 err = arm_kprobe(p);
2685 if (err) {
2686 errors++;
2687 ret = err;
2688 }
2689 total++;
2690 }
2691 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002692 }
2693
Jessica Yu12310e342018-01-10 00:51:23 +01002694 if (errors)
2695 pr_warn("Kprobes globally enabled, but failed to arm %d out of %d probes\n",
2696 errors, total);
2697 else
2698 pr_info("Kprobes globally enabled\n");
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002699
2700already_enabled:
2701 mutex_unlock(&kprobe_mutex);
Jessica Yu12310e342018-01-10 00:51:23 +01002702 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002703}
2704
Jessica Yu297f9232018-01-10 00:51:24 +01002705static int disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002706{
2707 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002708 struct kprobe *p;
Jessica Yu297f9232018-01-10 00:51:24 +01002709 unsigned int i, total = 0, errors = 0;
2710 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002711
2712 mutex_lock(&kprobe_mutex);
2713
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002714 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002715 if (kprobes_all_disarmed) {
2716 mutex_unlock(&kprobe_mutex);
Jessica Yu297f9232018-01-10 00:51:24 +01002717 return 0;
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002718 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002719
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002720 kprobes_all_disarmed = true;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002721
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002722 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2723 head = &kprobe_table[i];
Jessica Yu297f9232018-01-10 00:51:24 +01002724 /* Disarm all kprobes on a best-effort basis */
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002725 hlist_for_each_entry(p, head, hlist) {
Jessica Yu297f9232018-01-10 00:51:24 +01002726 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2727 err = disarm_kprobe(p, false);
2728 if (err) {
2729 errors++;
2730 ret = err;
2731 }
2732 total++;
2733 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002734 }
2735 }
Jessica Yu297f9232018-01-10 00:51:24 +01002736
2737 if (errors)
2738 pr_warn("Kprobes globally disabled, but failed to disarm %d out of %d probes\n",
2739 errors, total);
2740 else
2741 pr_info("Kprobes globally disabled\n");
2742
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002743 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002744
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002745 /* Wait for disarming all kprobes by optimizer */
2746 wait_for_kprobe_optimizer();
Jessica Yu297f9232018-01-10 00:51:24 +01002747
2748 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002749}
2750
2751/*
2752 * XXX: The debugfs bool file interface doesn't allow for callbacks
2753 * when the bool state is switched. We can reuse that facility when
2754 * available
2755 */
2756static ssize_t read_enabled_file_bool(struct file *file,
2757 char __user *user_buf, size_t count, loff_t *ppos)
2758{
2759 char buf[3];
2760
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002761 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002762 buf[0] = '1';
2763 else
2764 buf[0] = '0';
2765 buf[1] = '\n';
2766 buf[2] = 0x00;
2767 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2768}
2769
2770static ssize_t write_enabled_file_bool(struct file *file,
2771 const char __user *user_buf, size_t count, loff_t *ppos)
2772{
2773 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002774 size_t buf_size;
Jessica Yu12310e342018-01-10 00:51:23 +01002775 int ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002776
2777 buf_size = min(count, (sizeof(buf)-1));
2778 if (copy_from_user(buf, user_buf, buf_size))
2779 return -EFAULT;
2780
Mathias Krause10fb46d2013-07-03 15:05:39 -07002781 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002782 switch (buf[0]) {
2783 case 'y':
2784 case 'Y':
2785 case '1':
Jessica Yu12310e342018-01-10 00:51:23 +01002786 ret = arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002787 break;
2788 case 'n':
2789 case 'N':
2790 case '0':
Jessica Yu297f9232018-01-10 00:51:24 +01002791 ret = disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002792 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002793 default:
2794 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002795 }
2796
Jessica Yu12310e342018-01-10 00:51:23 +01002797 if (ret)
2798 return ret;
2799
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002800 return count;
2801}
2802
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002803static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002804 .read = read_enabled_file_bool,
2805 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002806 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002807};
2808
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002809static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002810{
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002811 struct dentry *dir;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002812 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002813
2814 dir = debugfs_create_dir("kprobes", NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002815
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002816 debugfs_create_file("list", 0400, dir, NULL, &kprobes_fops);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002817
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002818 debugfs_create_file("enabled", 0600, dir, &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002819
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002820 debugfs_create_file("blacklist", 0400, dir, NULL,
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002821 &kprobe_blacklist_fops);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002822
Srinivasa Ds346fd592007-02-20 13:57:54 -08002823 return 0;
2824}
2825
2826late_initcall(debugfs_kprobe_init);
2827#endif /* CONFIG_DEBUG_FS */