blob: d9770a5393c89925d2fa3f391dfb341a34a70409 [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>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070038
Christoph Hellwigbfd45be2016-10-11 13:52:22 -070039#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <asm/cacheflush.h>
41#include <asm/errno.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080042#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44#define KPROBE_HASH_BITS 6
45#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
46
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070047
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070048static int kprobes_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
Hien Nguyenb94cce92005-06-23 00:09:19 -070050static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070052/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070053static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070054
Masami Hiramatsu43948f52010-10-25 22:18:01 +090055/* This protects kprobe_table and optimizing_list */
56static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080057static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070058static struct {
Thomas Gleixnerec4846082009-07-25 16:09:17 +020059 raw_spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070060} kretprobe_table_locks[KPROBE_TABLE_SIZE];
61
Naveen N. Rao290e3072017-04-19 18:21:01 +053062kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
63 unsigned int __unused)
Naveen N. Rao49e0b462017-04-19 18:21:00 +053064{
65 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
66}
67
Thomas Gleixnerec4846082009-07-25 16:09:17 +020068static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070069{
70 return &(kretprobe_table_locks[hash].lock);
71}
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Masami Hiramatsu376e2422014-04-17 17:17:05 +090073/* Blacklist -- list of struct kprobe_blacklist_entry */
74static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070075
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080076#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070077/*
78 * kprobe->ainsn.insn points to the copy of the instruction to be
79 * single-stepped. x86_64, POWER4 and above have no-exec support and
80 * stepping on the instruction on a vmalloced/kmalloced/data page
81 * is a recipe for disaster
82 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070083struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -040084 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070085 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -070086 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070087 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080088 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050089 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070090};
91
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050092#define KPROBE_INSN_PAGE_SIZE(slots) \
93 (offsetof(struct kprobe_insn_page, slot_used) + \
94 (sizeof(char) * (slots)))
95
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050096static int slots_per_page(struct kprobe_insn_cache *c)
97{
98 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
99}
100
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800101enum kprobe_slot_state {
102 SLOT_CLEAN = 0,
103 SLOT_DIRTY = 1,
104 SLOT_USED = 2,
105};
106
Masami Hiramatsu63fef142017-08-18 17:24:00 +0900107void __weak *alloc_insn_page(void)
Heiko Carstensaf963972013-09-11 14:24:13 -0700108{
109 return module_alloc(PAGE_SIZE);
110}
111
Masami Hiramatsuc93f5cf2017-05-25 19:38:17 +0900112void __weak free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700113{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030114 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700115}
116
Heiko Carstensc802d642013-09-11 14:24:11 -0700117struct kprobe_insn_cache kprobe_insn_slots = {
118 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700119 .alloc = alloc_insn_page,
120 .free = free_insn_page,
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500121 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
122 .insn_size = MAX_INSN_SIZE,
123 .nr_garbage = 0,
124};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900125static int collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800126
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700127/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800128 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700129 * We allocate an executable page if there's no room on existing ones.
130 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900131kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700132{
133 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700134 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700135
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900136 /* Since the slot array is not protected by rcu, we need a mutex */
Heiko Carstensc802d642013-09-11 14:24:11 -0700137 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700138 retry:
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900139 rcu_read_lock();
140 list_for_each_entry_rcu(kip, &c->pages, list) {
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500141 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700142 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500143 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800144 if (kip->slot_used[i] == SLOT_CLEAN) {
145 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700146 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700147 slot = kip->insns + (i * c->insn_size);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900148 rcu_read_unlock();
Heiko Carstensc802d642013-09-11 14:24:11 -0700149 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700150 }
151 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500152 /* kip->nused is broken. Fix it. */
153 kip->nused = slots_per_page(c);
154 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700155 }
156 }
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900157 rcu_read_unlock();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700158
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800159 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500160 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800161 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500162
163 /* All out of space. Need to allocate a new page. */
164 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700165 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700166 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700167
168 /*
169 * Use module_alloc so this page is within +/- 2GB of where the
170 * kernel image and loaded module images reside. This is required
171 * so x86_64 can correctly handle the %rip-relative fixups.
172 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700173 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700174 if (!kip->insns) {
175 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700176 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700177 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400178 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500179 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800180 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700181 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800182 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700183 kip->cache = c;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900184 list_add_rcu(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700185 slot = kip->insns;
186out:
187 mutex_unlock(&c->mutex);
188 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800189}
190
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800191/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900192static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800193{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800194 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800195 kip->nused--;
196 if (kip->nused == 0) {
197 /*
198 * Page is no longer in use. Free it unless
199 * it's the last one. We keep the last one
200 * so as not to have to set it up again the
201 * next time somebody inserts a probe.
202 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500203 if (!list_is_singular(&kip->list)) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900204 list_del_rcu(&kip->list);
205 synchronize_rcu();
Heiko Carstensaf963972013-09-11 14:24:13 -0700206 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800207 kfree(kip);
208 }
209 return 1;
210 }
211 return 0;
212}
213
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900214static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800215{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400216 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800217
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500218 /* Ensure no-one is interrupted on the garbages */
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -0800219 synchronize_rcu();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800220
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500221 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800222 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800223 if (kip->ngarbage == 0)
224 continue;
225 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500226 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900227 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800228 break;
229 }
230 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500231 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800232 return 0;
233}
234
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900235void __free_insn_slot(struct kprobe_insn_cache *c,
236 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500237{
238 struct kprobe_insn_page *kip;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900239 long idx;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500240
Heiko Carstensc802d642013-09-11 14:24:11 -0700241 mutex_lock(&c->mutex);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900242 rcu_read_lock();
243 list_for_each_entry_rcu(kip, &c->pages, list) {
244 idx = ((long)slot - (long)kip->insns) /
245 (c->insn_size * sizeof(kprobe_opcode_t));
246 if (idx >= 0 && idx < slots_per_page(c))
Heiko Carstensc802d642013-09-11 14:24:11 -0700247 goto out;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900248 }
249 /* Could not find this slot. */
250 WARN_ON(1);
251 kip = NULL;
252out:
253 rcu_read_unlock();
254 /* Mark and sweep: this may sleep */
255 if (kip) {
256 /* Check double free */
257 WARN_ON(kip->slot_used[idx] != SLOT_USED);
258 if (dirty) {
259 kip->slot_used[idx] = SLOT_DIRTY;
260 kip->ngarbage++;
261 if (++c->nr_garbage > slots_per_page(c))
262 collect_garbage_slots(c);
263 } else {
264 collect_one_slot(kip, idx);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500265 }
266 }
Heiko Carstensc802d642013-09-11 14:24:11 -0700267 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500268}
269
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900270/*
271 * Check given address is on the page of kprobe instruction slots.
272 * This will be used for checking whether the address on a stack
273 * is on a text area or not.
274 */
275bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
276{
277 struct kprobe_insn_page *kip;
278 bool ret = false;
279
280 rcu_read_lock();
281 list_for_each_entry_rcu(kip, &c->pages, list) {
282 if (addr >= (unsigned long)kip->insns &&
283 addr < (unsigned long)kip->insns + PAGE_SIZE) {
284 ret = true;
285 break;
286 }
287 }
288 rcu_read_unlock();
289
290 return ret;
291}
292
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500293#ifdef CONFIG_OPTPROBES
294/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700295struct kprobe_insn_cache kprobe_optinsn_slots = {
296 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700297 .alloc = alloc_insn_page,
298 .free = free_insn_page,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500299 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
300 /* .insn_size is initialized later */
301 .nr_garbage = 0,
302};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500303#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800304#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700305
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800306/* We have preemption disabled.. so it is safe to use __ versions */
307static inline void set_kprobe_instance(struct kprobe *kp)
308{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600309 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800310}
311
312static inline void reset_kprobe_instance(void)
313{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600314 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800315}
316
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800317/*
318 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800319 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800320 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800321 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800322 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900323struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
325 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800326 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800329 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (p->addr == addr)
331 return p;
332 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 return NULL;
335}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900336NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900338static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500339
340/* Return true if the kprobe is an aggregator */
341static inline int kprobe_aggrprobe(struct kprobe *p)
342{
343 return p->pre_handler == aggr_pre_handler;
344}
345
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900346/* Return true(!0) if the kprobe is unused */
347static inline int kprobe_unused(struct kprobe *p)
348{
349 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
350 list_empty(&p->list);
351}
352
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500353/*
354 * Keep all fields in the kprobe consistent
355 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900356static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500357{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900358 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
359 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500360}
361
362#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500363/* NOTE: change this value only with kprobe_mutex held */
364static bool kprobes_allow_optimization;
365
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500366/*
367 * Call all pre_handler on the list, but ignores its return value.
368 * This must be called from arch-dep optimized caller.
369 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900370void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500371{
372 struct kprobe *kp;
373
374 list_for_each_entry_rcu(kp, &p->list, list) {
375 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
376 set_kprobe_instance(kp);
Naveen N. Rao4f3a8712017-10-17 13:48:34 +0530377 kp->pre_handler(kp, regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500378 }
379 reset_kprobe_instance();
380 }
381}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900382NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500383
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900384/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900385static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900386{
387 struct optimized_kprobe *op;
388
389 op = container_of(p, struct optimized_kprobe, kp);
390 arch_remove_optimized_kprobe(op);
391 arch_remove_kprobe(p);
392 kfree(op);
393}
394
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500395/* Return true(!0) if the kprobe is ready for optimization. */
396static inline int kprobe_optready(struct kprobe *p)
397{
398 struct optimized_kprobe *op;
399
400 if (kprobe_aggrprobe(p)) {
401 op = container_of(p, struct optimized_kprobe, kp);
402 return arch_prepared_optinsn(&op->optinsn);
403 }
404
405 return 0;
406}
407
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900408/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
409static inline int kprobe_disarmed(struct kprobe *p)
410{
411 struct optimized_kprobe *op;
412
413 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
414 if (!kprobe_aggrprobe(p))
415 return kprobe_disabled(p);
416
417 op = container_of(p, struct optimized_kprobe, kp);
418
419 return kprobe_disabled(p) && list_empty(&op->list);
420}
421
422/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900423static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900424{
425 struct optimized_kprobe *op;
426
427 if (kprobe_aggrprobe(p)) {
428 op = container_of(p, struct optimized_kprobe, kp);
429 if (!list_empty(&op->list))
430 return 1;
431 }
432 return 0;
433}
434
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500435/*
436 * Return an optimized kprobe whose optimizing code replaces
437 * instructions including addr (exclude breakpoint).
438 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900439static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500440{
441 int i;
442 struct kprobe *p = NULL;
443 struct optimized_kprobe *op;
444
445 /* Don't check i == 0, since that is a breakpoint case. */
446 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
447 p = get_kprobe((void *)(addr - i));
448
449 if (p && kprobe_optready(p)) {
450 op = container_of(p, struct optimized_kprobe, kp);
451 if (arch_within_optimized_kprobe(op, addr))
452 return p;
453 }
454
455 return NULL;
456}
457
458/* Optimization staging list, protected by kprobe_mutex */
459static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900460static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900461static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500462
463static void kprobe_optimizer(struct work_struct *work);
464static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
465#define OPTIMIZE_DELAY 5
466
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900467/*
468 * Optimize (replace a breakpoint with a jump) kprobes listed on
469 * optimizing_list.
470 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900471static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500472{
Andrea Righif1c6ece2019-08-12 20:43:02 +0200473 lockdep_assert_held(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500474 /*
475 * The optimization/unoptimization refers online_cpus via
476 * stop_machine() and cpu-hotplug modifies online_cpus.
477 * And same time, text_mutex will be held in cpu-hotplug and here.
478 * This combination can cause a deadlock (cpu-hotplug try to lock
479 * text_mutex but stop_machine can not be done because online_cpus
480 * has been changed)
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200481 * To avoid this deadlock, caller must have locked cpu hotplug
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500482 * for preventing cpu-hotplug outside of text_mutex locking.
483 */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200484 lockdep_assert_cpus_held();
485
486 /* Optimization never be done when disarmed */
487 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
488 list_empty(&optimizing_list))
489 return;
490
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900491 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900492}
493
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900494/*
495 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
496 * if need) kprobes listed on unoptimizing_list.
497 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900498static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900499{
500 struct optimized_kprobe *op, *tmp;
501
Andrea Righif1c6ece2019-08-12 20:43:02 +0200502 lockdep_assert_held(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200503 /* See comment in do_optimize_kprobes() */
504 lockdep_assert_cpus_held();
505
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900506 /* Unoptimization must be done anytime */
507 if (list_empty(&unoptimizing_list))
508 return;
509
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900510 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900511 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900512 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900513 /* Disarm probes if marked disabled */
514 if (kprobe_disabled(&op->kp))
515 arch_disarm_kprobe(&op->kp);
516 if (kprobe_unused(&op->kp)) {
517 /*
518 * Remove unused probes from hash list. After waiting
519 * for synchronization, these probes are reclaimed.
520 * (reclaiming is done by do_free_cleaned_kprobes.)
521 */
522 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900523 } else
524 list_del_init(&op->list);
525 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900526}
527
528/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900529static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900530{
531 struct optimized_kprobe *op, *tmp;
532
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900533 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900534 list_del_init(&op->list);
Masami Hiramatsucbdd96f2018-09-11 19:21:09 +0900535 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
536 /*
537 * This must not happen, but if there is a kprobe
538 * still in use, keep it on kprobes hash list.
539 */
540 continue;
541 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900542 free_aggr_kprobe(&op->kp);
543 }
544}
545
546/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900547static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900548{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800549 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900550}
551
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900552/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900553static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900554{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900555 mutex_lock(&kprobe_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200556 cpus_read_lock();
Andrea Righif1c6ece2019-08-12 20:43:02 +0200557 mutex_lock(&text_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900558 /* Lock modules while optimizing kprobes */
559 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900560
561 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900562 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
563 * kprobes before waiting for quiesence period.
564 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900565 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900566
567 /*
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900568 * Step 2: Wait for quiesence period to ensure all potentially
569 * preempted tasks to have normally scheduled. Because optprobe
570 * may modify multiple instructions, there is a chance that Nth
571 * instruction is preempted. In that case, such tasks can return
572 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
573 * Note that on non-preemptive kernel, this is transparently converted
574 * to synchronoze_sched() to wait for all interrupts to have completed.
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900575 */
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900576 synchronize_rcu_tasks();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900577
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900578 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900579 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900580
581 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900582 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900583
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500584 mutex_unlock(&module_mutex);
Andrea Righif1c6ece2019-08-12 20:43:02 +0200585 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200586 cpus_read_unlock();
Steven Rostedt72ef3792012-06-05 19:28:14 +0900587 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900588
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900589 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900590 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900591 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900592}
593
594/* Wait for completing optimization and unoptimization */
Thomas Gleixner30e7d8942017-05-17 10:19:49 +0200595void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900596{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800597 mutex_lock(&kprobe_mutex);
598
599 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
600 mutex_unlock(&kprobe_mutex);
601
602 /* this will also make optimizing_work execute immmediately */
603 flush_delayed_work(&optimizing_work);
604 /* @optimizing_work might not have been queued yet, relax */
605 cpu_relax();
606
607 mutex_lock(&kprobe_mutex);
608 }
609
610 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500611}
612
613/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900614static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500615{
616 struct optimized_kprobe *op;
617
618 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500619 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500620 (kprobe_disabled(p) || kprobes_all_disarmed))
621 return;
622
Masami Hiramatsu059053a2018-06-20 01:10:27 +0900623 /* kprobes with post_handler can not be optimized */
624 if (p->post_handler)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500625 return;
626
627 op = container_of(p, struct optimized_kprobe, kp);
628
629 /* Check there is no other kprobes at the optimized instructions */
630 if (arch_check_optimized_kprobe(op) < 0)
631 return;
632
633 /* Check if it is already optimized. */
634 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
635 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500636 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900637
638 if (!list_empty(&op->list))
639 /* This is under unoptimizing. Just dequeue the probe */
640 list_del_init(&op->list);
641 else {
642 list_add(&op->list, &optimizing_list);
643 kick_kprobe_optimizer();
644 }
645}
646
647/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900648static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900649{
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200650 lockdep_assert_cpus_held();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900651 arch_unoptimize_kprobe(op);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900652 if (kprobe_disabled(&op->kp))
653 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500654}
655
656/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900657static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500658{
659 struct optimized_kprobe *op;
660
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900661 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
662 return; /* This is not an optprobe nor optimized */
663
664 op = container_of(p, struct optimized_kprobe, kp);
665 if (!kprobe_optimized(p)) {
666 /* Unoptimized or unoptimizing case */
667 if (force && !list_empty(&op->list)) {
668 /*
669 * Only if this is unoptimizing kprobe and forced,
670 * forcibly unoptimize it. (No need to unoptimize
671 * unoptimized kprobe again :)
672 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500673 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900674 force_unoptimize_kprobe(op);
675 }
676 return;
677 }
678
679 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
680 if (!list_empty(&op->list)) {
681 /* Dequeue from the optimization queue */
682 list_del_init(&op->list);
683 return;
684 }
685 /* Optimized kprobe case */
686 if (force)
687 /* Forcibly update the code: this is a special case */
688 force_unoptimize_kprobe(op);
689 else {
690 list_add(&op->list, &unoptimizing_list);
691 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500692 }
693}
694
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900695/* Cancel unoptimizing for reusing */
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900696static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900697{
698 struct optimized_kprobe *op;
699
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900700 /*
701 * Unused kprobe MUST be on the way of delayed unoptimizing (means
702 * there is still a relative jump) and disabled.
703 */
704 op = container_of(ap, struct optimized_kprobe, kp);
Masami Hiramatsu44585152018-04-28 21:36:33 +0900705 WARN_ON_ONCE(list_empty(&op->list));
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900706 /* Enable the probe again */
707 ap->flags &= ~KPROBE_FLAG_DISABLED;
708 /* Optimize it again (remove from op->list) */
Masami Hiramatsu5f843ed2019-04-15 15:01:25 +0900709 if (!kprobe_optready(ap))
710 return -EINVAL;
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900711
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900712 optimize_kprobe(ap);
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900713 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900714}
715
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500716/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900717static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500718{
719 struct optimized_kprobe *op;
720
721 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900722 if (!list_empty(&op->list))
723 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500724 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900725 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900726
727 if (kprobe_unused(p)) {
728 /* Enqueue if it is unused */
729 list_add(&op->list, &freeing_list);
730 /*
731 * Remove unused probes from the hash list. After waiting
732 * for synchronization, this probe is reclaimed.
733 * (reclaiming is done by do_free_cleaned_kprobes().)
734 */
735 hlist_del_rcu(&op->kp.hlist);
736 }
737
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900738 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500739 arch_remove_optimized_kprobe(op);
740}
741
Masami Hiramatsua4602462017-04-19 18:22:25 +0530742static inline
743void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
744{
745 if (!kprobe_ftrace(p))
746 arch_prepare_optimized_kprobe(op, p);
747}
748
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500749/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900750static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500751{
752 struct optimized_kprobe *op;
753
754 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530755 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500756}
757
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500758/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900759static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500760{
761 struct optimized_kprobe *op;
762
763 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
764 if (!op)
765 return NULL;
766
767 INIT_LIST_HEAD(&op->list);
768 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530769 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500770
771 return &op->kp;
772}
773
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900774static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500775
776/*
777 * Prepare an optimized_kprobe and optimize it
778 * NOTE: p must be a normal registered kprobe
779 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900780static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500781{
782 struct kprobe *ap;
783 struct optimized_kprobe *op;
784
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900785 /* Impossible to optimize ftrace-based kprobe */
786 if (kprobe_ftrace(p))
787 return;
788
Masami Hiramatsu25764282012-06-05 19:28:26 +0900789 /* For preparing optimization, jump_label_text_reserved() is called */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200790 cpus_read_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +0900791 jump_label_lock();
792 mutex_lock(&text_mutex);
793
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500794 ap = alloc_aggr_kprobe(p);
795 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900796 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500797
798 op = container_of(ap, struct optimized_kprobe, kp);
799 if (!arch_prepared_optinsn(&op->optinsn)) {
800 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900801 arch_remove_optimized_kprobe(op);
802 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900803 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500804 }
805
806 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900807 optimize_kprobe(ap); /* This just kicks optimizer thread */
808
809out:
810 mutex_unlock(&text_mutex);
811 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200812 cpus_read_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500813}
814
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500815#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900816static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500817{
818 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500819 struct kprobe *p;
820 unsigned int i;
821
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900822 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500823 /* If optimization is already allowed, just return */
824 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900825 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500826
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200827 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500828 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500829 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
830 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800831 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500832 if (!kprobe_disabled(p))
833 optimize_kprobe(p);
834 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200835 cpus_read_unlock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500836 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900837out:
838 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500839}
840
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900841static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500842{
843 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500844 struct kprobe *p;
845 unsigned int i;
846
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900847 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500848 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900849 if (!kprobes_allow_optimization) {
850 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500851 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900852 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500853
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200854 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500855 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500856 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
857 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800858 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500859 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900860 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500861 }
862 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200863 cpus_read_unlock();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900864 mutex_unlock(&kprobe_mutex);
865
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900866 /* Wait for unoptimizing completion */
867 wait_for_kprobe_optimizer();
868 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500869}
870
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900871static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500872int sysctl_kprobes_optimization;
873int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
874 void __user *buffer, size_t *length,
875 loff_t *ppos)
876{
877 int ret;
878
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900879 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500880 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
881 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
882
883 if (sysctl_kprobes_optimization)
884 optimize_all_kprobes();
885 else
886 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900887 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500888
889 return ret;
890}
891#endif /* CONFIG_SYSCTL */
892
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900893/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900894static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500895{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900896 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500897
898 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900899 _p = get_optimized_kprobe((unsigned long)p->addr);
900 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900901 /* Fallback to unoptimized kprobe */
902 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500903
904 arch_arm_kprobe(p);
905 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
906}
907
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900908/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900909static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500910{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900911 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500912
Wang Nan69d54b92015-02-13 14:40:26 -0800913 /* Try to unoptimize */
914 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500915
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900916 if (!kprobe_queued(p)) {
917 arch_disarm_kprobe(p);
918 /* If another kprobe was blocked, optimize it. */
919 _p = get_optimized_kprobe((unsigned long)p->addr);
920 if (unlikely(_p) && reopt)
921 optimize_kprobe(_p);
922 }
923 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500924}
925
926#else /* !CONFIG_OPTPROBES */
927
928#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900929#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500930#define kill_optimized_kprobe(p) do {} while (0)
931#define prepare_optimized_kprobe(p) do {} while (0)
932#define try_to_optimize_kprobe(p) do {} while (0)
933#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900934#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
935#define kprobe_disarmed(p) kprobe_disabled(p)
936#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500937
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900938static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900939{
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900940 /*
941 * If the optimized kprobe is NOT supported, the aggr kprobe is
942 * released at the same time that the last aggregated kprobe is
943 * unregistered.
944 * Thus there should be no chance to reuse unused kprobe.
945 */
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900946 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900947 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900948}
949
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900950static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500951{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900952 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500953 kfree(p);
954}
955
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900956static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500957{
958 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
959}
960#endif /* CONFIG_OPTPROBES */
961
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900962#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900963static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900964 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500965 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900966};
967static int kprobe_ftrace_enabled;
968
969/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900970static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900971{
972 if (!kprobe_ftrace(p))
973 return arch_prepare_kprobe(p);
974
975 return arch_prepare_kprobe_ftrace(p);
976}
977
978/* Caller must lock kprobe_mutex */
Jessica Yu12310e342018-01-10 00:51:23 +0100979static int arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900980{
Jessica Yu12310e342018-01-10 00:51:23 +0100981 int ret = 0;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900982
983 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
984 (unsigned long)p->addr, 0, 0);
Jessica Yu12310e342018-01-10 00:51:23 +0100985 if (ret) {
Masami Hiramatsu44585152018-04-28 21:36:33 +0900986 pr_debug("Failed to arm kprobe-ftrace at %pS (%d)\n",
987 p->addr, ret);
Jessica Yu12310e342018-01-10 00:51:23 +0100988 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900989 }
Jessica Yu12310e342018-01-10 00:51:23 +0100990
991 if (kprobe_ftrace_enabled == 0) {
992 ret = register_ftrace_function(&kprobe_ftrace_ops);
993 if (ret) {
994 pr_debug("Failed to init kprobe-ftrace (%d)\n", ret);
995 goto err_ftrace;
996 }
997 }
998
999 kprobe_ftrace_enabled++;
1000 return ret;
1001
1002err_ftrace:
1003 /*
1004 * Note: Since kprobe_ftrace_ops has IPMODIFY set, and ftrace requires a
1005 * non-empty filter_hash for IPMODIFY ops, we're safe from an accidental
1006 * empty filter_hash which would undesirably trace all functions.
1007 */
1008 ftrace_set_filter_ip(&kprobe_ftrace_ops, (unsigned long)p->addr, 1, 0);
1009 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001010}
1011
1012/* Caller must lock kprobe_mutex */
Jessica Yu297f9232018-01-10 00:51:24 +01001013static int disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001014{
Jessica Yu297f9232018-01-10 00:51:24 +01001015 int ret = 0;
1016
1017 if (kprobe_ftrace_enabled == 1) {
1018 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
1019 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (%d)\n", ret))
1020 return ret;
1021 }
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001022
1023 kprobe_ftrace_enabled--;
Jessica Yu297f9232018-01-10 00:51:24 +01001024
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001025 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1026 (unsigned long)p->addr, 1, 0);
Masami Hiramatsu44585152018-04-28 21:36:33 +09001027 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (%d)\n",
1028 p->addr, ret);
Jessica Yu297f9232018-01-10 00:51:24 +01001029 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001030}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001031#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001032#define prepare_kprobe(p) arch_prepare_kprobe(p)
Jessica Yu12310e342018-01-10 00:51:23 +01001033#define arm_kprobe_ftrace(p) (-ENODEV)
Jessica Yu297f9232018-01-10 00:51:24 +01001034#define disarm_kprobe_ftrace(p) (-ENODEV)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001035#endif
1036
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001037/* Arm a kprobe with text_mutex */
Jessica Yu12310e342018-01-10 00:51:23 +01001038static int arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001039{
Jessica Yu12310e342018-01-10 00:51:23 +01001040 if (unlikely(kprobe_ftrace(kp)))
1041 return arm_kprobe_ftrace(kp);
1042
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001043 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001044 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001045 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001046 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001047 cpus_read_unlock();
Jessica Yu12310e342018-01-10 00:51:23 +01001048
1049 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001050}
1051
1052/* Disarm a kprobe with text_mutex */
Jessica Yu297f9232018-01-10 00:51:24 +01001053static int disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001054{
Jessica Yu297f9232018-01-10 00:51:24 +01001055 if (unlikely(kprobe_ftrace(kp)))
1056 return disarm_kprobe_ftrace(kp);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001057
1058 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001059 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001060 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001061 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001062 cpus_read_unlock();
Jessica Yu297f9232018-01-10 00:51:24 +01001063
1064 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001065}
1066
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001067/*
1068 * Aggregate handlers for multiple kprobes support - these handlers
1069 * take care of invoking the individual kprobe handlers on p->list
1070 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001071static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001072{
1073 struct kprobe *kp;
1074
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001075 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001076 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001077 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001078 if (kp->pre_handler(kp, regs))
1079 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001080 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001081 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001082 }
1083 return 0;
1084}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001085NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001086
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001087static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1088 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001089{
1090 struct kprobe *kp;
1091
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001092 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001093 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001094 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001095 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001096 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001097 }
1098 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001099}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001100NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001101
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001102static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1103 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001104{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001105 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001106
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001107 /*
1108 * if we faulted "during" the execution of a user specified
1109 * probe handler, invoke just that probe's fault handler
1110 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001111 if (cur && cur->fault_handler) {
1112 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001113 return 1;
1114 }
1115 return 0;
1116}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001117NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001118
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001119/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001120void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001121{
1122 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001123 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001124 p->nmissed++;
1125 } else {
1126 list_for_each_entry_rcu(kp, &p->list, list)
1127 kp->nmissed++;
1128 }
1129 return;
1130}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001131NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001132
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001133void recycle_rp_inst(struct kretprobe_instance *ri,
1134 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001135{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001136 struct kretprobe *rp = ri->rp;
1137
Hien Nguyenb94cce92005-06-23 00:09:19 -07001138 /* remove rp inst off the rprobe_inst_table */
1139 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001140 INIT_HLIST_NODE(&ri->hlist);
1141 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001142 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001143 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001144 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001145 } else
1146 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001147 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001148}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001149NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001150
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001151void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001152 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001153__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001154{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001155 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001156 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001157
1158 *head = &kretprobe_inst_table[hash];
1159 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001160 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001161}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001162NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001163
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001164static void kretprobe_table_lock(unsigned long hash,
1165 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001166__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001167{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001168 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1169 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001170}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001171NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001172
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001173void kretprobe_hash_unlock(struct task_struct *tsk,
1174 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001175__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001176{
1177 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001178 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001179
1180 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001181 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001182}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001183NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001184
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001185static void kretprobe_table_unlock(unsigned long hash,
1186 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001187__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001188{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001189 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1190 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001191}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001192NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001193
Hien Nguyenb94cce92005-06-23 00:09:19 -07001194/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001195 * This function is called from finish_task_switch when task tk becomes dead,
1196 * so that we can recycle any function-return probe instances associated
1197 * with this task. These left over instances represent probed functions
1198 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001199 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001200void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001201{
bibo,mao62c27be2006-10-02 02:17:33 -07001202 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001203 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001204 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001205 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001206
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001207 if (unlikely(!kprobes_initialized))
1208 /* Early boot. kretprobe_table_locks not yet initialized. */
1209 return;
1210
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001211 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001212 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1213 head = &kretprobe_inst_table[hash];
1214 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001215 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001216 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001217 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001218 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001219 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001220 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001221 hlist_del(&ri->hlist);
1222 kfree(ri);
1223 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001224}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001225NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001226
Hien Nguyenb94cce92005-06-23 00:09:19 -07001227static inline void free_rp_inst(struct kretprobe *rp)
1228{
1229 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001230 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001231
Sasha Levinb67bfe02013-02-27 17:06:00 -08001232 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001233 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001234 kfree(ri);
1235 }
1236}
1237
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001238static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001239{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001240 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001241 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001242 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001243 struct hlist_head *head;
1244
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001245 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001246 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1247 kretprobe_table_lock(hash, &flags);
1248 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001249 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001250 if (ri->rp == rp)
1251 ri->rp = NULL;
1252 }
1253 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001254 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001255 free_rp_inst(rp);
1256}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001257NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001258
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001259/* Add the new probe to ap->list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001260static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001261{
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001262 if (p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001263 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001264
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001265 list_add_rcu(&p->list, &ap->list);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001266 if (p->post_handler && !ap->post_handler)
1267 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001268
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001269 return 0;
1270}
1271
1272/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001273 * Fill in the required fields of the "manager kprobe". Replace the
1274 * earlier kprobe in the hlist with the manager kprobe
1275 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001276static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001277{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001278 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001279 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001280 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001281 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001282 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001283 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001284 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001285 /* We don't care the kprobe which has gone. */
1286 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001287 ap->post_handler = aggr_post_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001288
1289 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001290 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001291
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001292 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001293 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001294}
1295
1296/*
1297 * This is the second or subsequent kprobe at the address - handle
1298 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001299 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001300static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001301{
1302 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001303 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001304
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001305 cpus_read_lock();
1306
Masami Hiramatsu25764282012-06-05 19:28:26 +09001307 /* For preparing optimization, jump_label_text_reserved() is called */
1308 jump_label_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001309 mutex_lock(&text_mutex);
1310
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001311 if (!kprobe_aggrprobe(orig_p)) {
1312 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1313 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001314 if (!ap) {
1315 ret = -ENOMEM;
1316 goto out;
1317 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001318 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001319 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001320 /* This probe is going to die. Rescue it */
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001321 ret = reuse_unused_kprobe(ap);
1322 if (ret)
1323 goto out;
1324 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001325
1326 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001327 /*
1328 * Attempting to insert new probe at the same location that
1329 * had a probe in the module vaddr area which already
1330 * freed. So, the instruction slot has already been
1331 * released. We need a new slot for the new probe.
1332 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001333 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001334 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001335 /*
1336 * Even if fail to allocate new slot, don't need to
1337 * free aggr_probe. It will be used next time, or
1338 * freed by unregister_kprobe.
1339 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001340 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001341
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001342 /* Prepare optimized instructions if possible. */
1343 prepare_optimized_kprobe(ap);
1344
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001345 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001346 * Clear gone flag to prevent allocating new slot again, and
1347 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001348 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001349 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1350 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001351 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001352
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001353 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001354 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001355 ret = add_new_kprobe(ap, p);
1356
1357out:
1358 mutex_unlock(&text_mutex);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001359 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001360 cpus_read_unlock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001361
1362 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1363 ap->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01001364 if (!kprobes_all_disarmed) {
Masami Hiramatsu25764282012-06-05 19:28:26 +09001365 /* Arm the breakpoint again. */
Jessica Yu12310e342018-01-10 00:51:23 +01001366 ret = arm_kprobe(ap);
1367 if (ret) {
1368 ap->flags |= KPROBE_FLAG_DISABLED;
1369 list_del_rcu(&p->list);
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001370 synchronize_rcu();
Jessica Yu12310e342018-01-10 00:51:23 +01001371 }
1372 }
Masami Hiramatsu25764282012-06-05 19:28:26 +09001373 }
1374 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001375}
1376
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001377bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1378{
1379 /* The __kprobes marked functions and entry code must not be probed */
1380 return addr >= (unsigned long)__kprobes_text_start &&
1381 addr < (unsigned long)__kprobes_text_end;
1382}
1383
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001384static bool __within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001385{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001386 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001387
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001388 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001389 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001390 /*
1391 * If there exists a kprobe_blacklist, verify and
1392 * fail any probe registration in the prohibited area
1393 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001394 list_for_each_entry(ent, &kprobe_blacklist, list) {
1395 if (addr >= ent->start_addr && addr < ent->end_addr)
1396 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001397 }
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001398 return false;
1399}
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001400
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001401bool within_kprobe_blacklist(unsigned long addr)
1402{
1403 char symname[KSYM_NAME_LEN], *p;
1404
1405 if (__within_kprobe_blacklist(addr))
1406 return true;
1407
1408 /* Check if the address is on a suffixed-symbol */
1409 if (!lookup_symbol_name(addr, symname)) {
1410 p = strchr(symname, '.');
1411 if (!p)
1412 return false;
1413 *p = '\0';
1414 addr = (unsigned long)kprobe_lookup_name(symname, 0);
1415 if (addr)
1416 return __within_kprobe_blacklist(addr);
1417 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001418 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001419}
1420
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001421/*
1422 * If we have a symbol_name argument, look it up and add the offset field
1423 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001424 * This returns encoded errors if it fails to look up symbol or invalid
1425 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001426 */
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301427static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1428 const char *symbol_name, unsigned int offset)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001429{
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301430 if ((symbol_name && addr) || (!symbol_name && !addr))
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001431 goto invalid;
1432
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301433 if (symbol_name) {
Linus Torvalds7246f602017-05-05 11:36:44 -07001434 addr = kprobe_lookup_name(symbol_name, offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001435 if (!addr)
1436 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001437 }
1438
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301439 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001440 if (addr)
1441 return addr;
1442
1443invalid:
1444 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001445}
1446
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301447static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1448{
1449 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1450}
1451
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301452/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001453static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301454{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001455 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301456
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001457 ap = get_kprobe(p->addr);
1458 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301459 return NULL;
1460
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001461 if (p != ap) {
1462 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301463 if (list_p == p)
1464 /* kprobe p is a valid probe */
1465 goto valid;
1466 return NULL;
1467 }
1468valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001469 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301470}
1471
1472/* Return error if the kprobe is being re-registered */
1473static inline int check_kprobe_rereg(struct kprobe *p)
1474{
1475 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301476
1477 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001478 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301479 ret = -EINVAL;
1480 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001481
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301482 return ret;
1483}
1484
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001485int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001487 unsigned long ftrace_addr;
1488
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001489 ftrace_addr = ftrace_location((unsigned long)p->addr);
1490 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001491#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001492 /* Given address is not on the instruction boundary */
1493 if ((unsigned long)p->addr != ftrace_addr)
1494 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001495 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001496#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001497 return -EINVAL;
1498#endif
1499 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001500 return 0;
1501}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001502
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001503static int check_kprobe_address_safe(struct kprobe *p,
1504 struct module **probed_mod)
1505{
1506 int ret;
1507
1508 ret = arch_check_ftrace_location(p);
1509 if (ret)
1510 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001511 jump_label_lock();
1512 preempt_disable();
1513
1514 /* Ensure it is not in reserved area nor out of text */
1515 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001516 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001517 jump_label_text_reserved(p->addr, p->addr)) {
1518 ret = -EINVAL;
1519 goto out;
1520 }
1521
1522 /* Check if are we probing a module */
1523 *probed_mod = __module_text_address((unsigned long) p->addr);
1524 if (*probed_mod) {
1525 /*
1526 * We must hold a refcount of the probed module while updating
1527 * its code to prohibit unexpected unloading.
1528 */
1529 if (unlikely(!try_module_get(*probed_mod))) {
1530 ret = -ENOENT;
1531 goto out;
1532 }
1533
1534 /*
1535 * If the module freed .init.text, we couldn't insert
1536 * kprobes in there.
1537 */
1538 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1539 (*probed_mod)->state != MODULE_STATE_COMING) {
1540 module_put(*probed_mod);
1541 *probed_mod = NULL;
1542 ret = -ENOENT;
1543 }
1544 }
1545out:
1546 preempt_enable();
1547 jump_label_unlock();
1548
1549 return ret;
1550}
1551
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001552int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001553{
1554 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001555 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001556 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001557 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001559 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001560 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001561 if (IS_ERR(addr))
1562 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001563 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001564
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301565 ret = check_kprobe_rereg(p);
1566 if (ret)
1567 return ret;
1568
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001569 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1570 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001571 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001572 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001573
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001574 ret = check_kprobe_address_safe(p, &probed_mod);
1575 if (ret)
1576 return ret;
1577
1578 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001579
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001580 old_p = get_kprobe(p->addr);
1581 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001582 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001583 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 goto out;
1585 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001587 cpus_read_lock();
1588 /* Prevent text modification */
1589 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001590 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001591 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001592 cpus_read_unlock();
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001593 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001594 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001595
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001596 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001597 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1599
Jessica Yu12310e342018-01-10 00:51:23 +01001600 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1601 ret = arm_kprobe(p);
1602 if (ret) {
1603 hlist_del_rcu(&p->hlist);
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001604 synchronize_rcu();
Jessica Yu12310e342018-01-10 00:51:23 +01001605 goto out;
1606 }
1607 }
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001608
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001609 /* Try to optimize kprobe */
1610 try_to_optimize_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001612 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001613
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001614 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001615 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001616
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 return ret;
1618}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001619EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001621/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001622static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001623{
1624 struct kprobe *kp;
1625
1626 list_for_each_entry_rcu(kp, &ap->list, list)
1627 if (!kprobe_disabled(kp))
1628 /*
1629 * There is an active probe on the list.
1630 * We can't disable this ap.
1631 */
1632 return 0;
1633
1634 return 1;
1635}
1636
1637/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001638static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001639{
1640 struct kprobe *orig_p;
Jessica Yu297f9232018-01-10 00:51:24 +01001641 int ret;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001642
1643 /* Get an original kprobe for return */
1644 orig_p = __get_valid_kprobe(p);
1645 if (unlikely(orig_p == NULL))
Jessica Yu297f9232018-01-10 00:51:24 +01001646 return ERR_PTR(-EINVAL);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001647
1648 if (!kprobe_disabled(p)) {
1649 /* Disable probe if it is a child probe */
1650 if (p != orig_p)
1651 p->flags |= KPROBE_FLAG_DISABLED;
1652
1653 /* Try to disarm and disable this/parent probe */
1654 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001655 /*
1656 * If kprobes_all_disarmed is set, orig_p
1657 * should have already been disarmed, so
1658 * skip unneed disarming process.
1659 */
Jessica Yu297f9232018-01-10 00:51:24 +01001660 if (!kprobes_all_disarmed) {
1661 ret = disarm_kprobe(orig_p, true);
1662 if (ret) {
1663 p->flags &= ~KPROBE_FLAG_DISABLED;
1664 return ERR_PTR(ret);
1665 }
1666 }
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001667 orig_p->flags |= KPROBE_FLAG_DISABLED;
1668 }
1669 }
1670
1671 return orig_p;
1672}
1673
Masami Hiramatsu98616682008-04-28 02:14:28 -07001674/*
1675 * Unregister a kprobe without a scheduler synchronization.
1676 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001677static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001678{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001679 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001680
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001681 /* Disable kprobe. This will disarm it if needed. */
1682 ap = __disable_kprobe(p);
Jessica Yu297f9232018-01-10 00:51:24 +01001683 if (IS_ERR(ap))
1684 return PTR_ERR(ap);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001685
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001686 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001687 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001688 * This probe is an independent(and non-optimized) kprobe
1689 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001690 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001691 goto disarmed;
1692
1693 /* Following process expects this probe is an aggrprobe */
1694 WARN_ON(!kprobe_aggrprobe(ap));
1695
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001696 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1697 /*
1698 * !disarmed could be happen if the probe is under delayed
1699 * unoptimizing.
1700 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001701 goto disarmed;
1702 else {
1703 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001704 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001705 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001706 if ((list_p != p) && (list_p->post_handler))
1707 goto noclean;
1708 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001709 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001710 }
1711noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001712 /*
1713 * Remove from the aggrprobe: this path will do nothing in
1714 * __unregister_kprobe_bottom().
1715 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001716 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001717 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1718 /*
1719 * Try to optimize this probe again, because post
1720 * handler may have been changed.
1721 */
1722 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001723 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001724 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001725
1726disarmed:
1727 hlist_del_rcu(&ap->hlist);
1728 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001729}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001730
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001731static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001732{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001733 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001734
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001735 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001736 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001737 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001738 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001739 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001740 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001741 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001742 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001743 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001744 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745}
1746
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001747int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001748{
1749 int i, ret = 0;
1750
1751 if (num <= 0)
1752 return -EINVAL;
1753 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001754 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001755 if (ret < 0) {
1756 if (i > 0)
1757 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001758 break;
1759 }
1760 }
1761 return ret;
1762}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001763EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001764
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001765void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001766{
1767 unregister_kprobes(&p, 1);
1768}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001769EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001770
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001771void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001772{
1773 int i;
1774
1775 if (num <= 0)
1776 return;
1777 mutex_lock(&kprobe_mutex);
1778 for (i = 0; i < num; i++)
1779 if (__unregister_kprobe_top(kps[i]) < 0)
1780 kps[i]->addr = NULL;
1781 mutex_unlock(&kprobe_mutex);
1782
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001783 synchronize_rcu();
Masami Hiramatsu98616682008-04-28 02:14:28 -07001784 for (i = 0; i < num; i++)
1785 if (kps[i]->addr)
1786 __unregister_kprobe_bottom(kps[i]);
1787}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001788EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001789
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301790int __weak kprobe_exceptions_notify(struct notifier_block *self,
1791 unsigned long val, void *data)
Naveen N. Raofc62d022017-02-08 01:24:14 +05301792{
1793 return NOTIFY_DONE;
1794}
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301795NOKPROBE_SYMBOL(kprobe_exceptions_notify);
Naveen N. Raofc62d022017-02-08 01:24:14 +05301796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797static struct notifier_block kprobe_exceptions_nb = {
1798 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001799 .priority = 0x7fffffff /* we need to be notified first */
1800};
1801
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001802unsigned long __weak arch_deref_entry_point(void *entry)
1803{
1804 return (unsigned long)entry;
1805}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001807#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001808/*
1809 * This kprobe pre_handler is registered with every kretprobe. When probe
1810 * hits it will set up the return probe.
1811 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001812static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001813{
1814 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001815 unsigned long hash, flags = 0;
1816 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001817
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001818 /*
1819 * To avoid deadlocks, prohibit return probing in NMI contexts,
1820 * just skip the probe and increase the (inexact) 'nmissed'
1821 * statistical counter, so that the user is informed that
1822 * something happened:
1823 */
1824 if (unlikely(in_nmi())) {
1825 rp->nmissed++;
1826 return 0;
1827 }
1828
1829 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001830 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001831 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001832 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001833 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001834 struct kretprobe_instance, hlist);
1835 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001836 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001837
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001838 ri->rp = rp;
1839 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001840
Jiang Liu55ca6142012-02-03 15:37:16 -08001841 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1842 raw_spin_lock_irqsave(&rp->lock, flags);
1843 hlist_add_head(&ri->hlist, &rp->free_instances);
1844 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001845 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001846 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001847
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001848 arch_prepare_kretprobe(ri, regs);
1849
1850 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001851 INIT_HLIST_NODE(&ri->hlist);
1852 kretprobe_table_lock(hash, &flags);
1853 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1854 kretprobe_table_unlock(hash, &flags);
1855 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001856 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001857 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001858 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001859 return 0;
1860}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001861NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001862
Naveen N. Rao659b9572017-07-07 22:37:24 +05301863bool __weak arch_kprobe_on_func_entry(unsigned long offset)
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301864{
1865 return !offset;
1866}
1867
Naveen N. Rao659b9572017-07-07 22:37:24 +05301868bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301869{
1870 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1871
1872 if (IS_ERR(kp_addr))
1873 return false;
1874
1875 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
Naveen N. Rao659b9572017-07-07 22:37:24 +05301876 !arch_kprobe_on_func_entry(offset))
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301877 return false;
1878
1879 return true;
1880}
1881
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001882int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001883{
1884 int ret = 0;
1885 struct kretprobe_instance *inst;
1886 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001887 void *addr;
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301888
Naveen N. Rao659b9572017-07-07 22:37:24 +05301889 if (!kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301890 return -EINVAL;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001891
1892 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001893 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001894 if (IS_ERR(addr))
1895 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001896
1897 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1898 if (kretprobe_blacklist[i].addr == addr)
1899 return -EINVAL;
1900 }
1901 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001902
1903 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001904 rp->kp.post_handler = NULL;
1905 rp->kp.fault_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001906
1907 /* Pre-allocate memory for max kretprobe instances */
1908 if (rp->maxactive <= 0) {
1909#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001910 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001911#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301912 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001913#endif
1914 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001915 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001916 INIT_HLIST_HEAD(&rp->free_instances);
1917 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001918 inst = kmalloc(sizeof(struct kretprobe_instance) +
1919 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001920 if (inst == NULL) {
1921 free_rp_inst(rp);
1922 return -ENOMEM;
1923 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001924 INIT_HLIST_NODE(&inst->hlist);
1925 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001926 }
1927
1928 rp->nmissed = 0;
1929 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001930 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001931 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001932 free_rp_inst(rp);
1933 return ret;
1934}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001935EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001936
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001937int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001938{
1939 int ret = 0, i;
1940
1941 if (num <= 0)
1942 return -EINVAL;
1943 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001944 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001945 if (ret < 0) {
1946 if (i > 0)
1947 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001948 break;
1949 }
1950 }
1951 return ret;
1952}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001953EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001954
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001955void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001956{
1957 unregister_kretprobes(&rp, 1);
1958}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001959EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001960
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001961void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001962{
1963 int i;
1964
1965 if (num <= 0)
1966 return;
1967 mutex_lock(&kprobe_mutex);
1968 for (i = 0; i < num; i++)
1969 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1970 rps[i]->kp.addr = NULL;
1971 mutex_unlock(&kprobe_mutex);
1972
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001973 synchronize_rcu();
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001974 for (i = 0; i < num; i++) {
1975 if (rps[i]->kp.addr) {
1976 __unregister_kprobe_bottom(&rps[i]->kp);
1977 cleanup_rp_inst(rps[i]);
1978 }
1979 }
1980}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001981EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001982
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001983#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001984int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001985{
1986 return -ENOSYS;
1987}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001988EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001989
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001990int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001991{
1992 return -ENOSYS;
1993}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001994EXPORT_SYMBOL_GPL(register_kretprobes);
1995
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001996void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001997{
1998}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001999EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002000
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002001void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002002{
2003}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002004EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002005
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002006static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002007{
2008 return 0;
2009}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002010NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002011
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002012#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002013
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002014/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002015static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002016{
2017 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002018
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002019 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002020 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002021 /*
2022 * If this is an aggr_kprobe, we have to list all the
2023 * chained probes and mark them GONE.
2024 */
2025 list_for_each_entry_rcu(kp, &p->list, list)
2026 kp->flags |= KPROBE_FLAG_GONE;
2027 p->post_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002028 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002029 }
2030 /*
2031 * Here, we can remove insn_slot safely, because no thread calls
2032 * the original probed function (which will be freed soon) any more.
2033 */
2034 arch_remove_kprobe(p);
2035}
2036
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002037/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002038int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002039{
2040 int ret = 0;
Jessica Yu297f9232018-01-10 00:51:24 +01002041 struct kprobe *p;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002042
2043 mutex_lock(&kprobe_mutex);
2044
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002045 /* Disable this kprobe */
Jessica Yu297f9232018-01-10 00:51:24 +01002046 p = __disable_kprobe(kp);
2047 if (IS_ERR(p))
2048 ret = PTR_ERR(p);
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002049
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002050 mutex_unlock(&kprobe_mutex);
2051 return ret;
2052}
2053EXPORT_SYMBOL_GPL(disable_kprobe);
2054
2055/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002056int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002057{
2058 int ret = 0;
2059 struct kprobe *p;
2060
2061 mutex_lock(&kprobe_mutex);
2062
2063 /* Check whether specified probe is valid. */
2064 p = __get_valid_kprobe(kp);
2065 if (unlikely(p == NULL)) {
2066 ret = -EINVAL;
2067 goto out;
2068 }
2069
2070 if (kprobe_gone(kp)) {
2071 /* This kprobe has gone, we couldn't enable it. */
2072 ret = -EINVAL;
2073 goto out;
2074 }
2075
2076 if (p != kp)
2077 kp->flags &= ~KPROBE_FLAG_DISABLED;
2078
2079 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2080 p->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01002081 ret = arm_kprobe(p);
2082 if (ret)
2083 p->flags |= KPROBE_FLAG_DISABLED;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002084 }
2085out:
2086 mutex_unlock(&kprobe_mutex);
2087 return ret;
2088}
2089EXPORT_SYMBOL_GPL(enable_kprobe);
2090
Masami Hiramatsu44585152018-04-28 21:36:33 +09002091/* Caller must NOT call this in usual path. This is only for critical case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002092void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002093{
Masami Hiramatsu44585152018-04-28 21:36:33 +09002094 pr_err("Dumping kprobe:\n");
2095 pr_err("Name: %s\nOffset: %x\nAddress: %pS\n",
2096 kp->symbol_name, kp->offset, kp->addr);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002097}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002098NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002099
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002100int kprobe_add_ksym_blacklist(unsigned long entry)
2101{
2102 struct kprobe_blacklist_entry *ent;
2103 unsigned long offset = 0, size = 0;
2104
2105 if (!kernel_text_address(entry) ||
2106 !kallsyms_lookup_size_offset(entry, &size, &offset))
2107 return -EINVAL;
2108
2109 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2110 if (!ent)
2111 return -ENOMEM;
2112 ent->start_addr = entry;
2113 ent->end_addr = entry + size;
2114 INIT_LIST_HEAD(&ent->list);
2115 list_add_tail(&ent->list, &kprobe_blacklist);
2116
2117 return (int)size;
2118}
2119
2120/* Add all symbols in given area into kprobe blacklist */
2121int kprobe_add_area_blacklist(unsigned long start, unsigned long end)
2122{
2123 unsigned long entry;
2124 int ret = 0;
2125
2126 for (entry = start; entry < end; entry += ret) {
2127 ret = kprobe_add_ksym_blacklist(entry);
2128 if (ret < 0)
2129 return ret;
2130 if (ret == 0) /* In case of alias symbol */
2131 ret = 1;
2132 }
2133 return 0;
2134}
2135
2136int __init __weak arch_populate_kprobe_blacklist(void)
2137{
2138 return 0;
2139}
2140
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002141/*
2142 * Lookup and populate the kprobe_blacklist.
2143 *
2144 * Unlike the kretprobe blacklist, we'll need to determine
2145 * the range of addresses that belong to the said functions,
2146 * since a kprobe need not necessarily be at the beginning
2147 * of a function.
2148 */
2149static int __init populate_kprobe_blacklist(unsigned long *start,
2150 unsigned long *end)
2151{
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002152 unsigned long entry;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002153 unsigned long *iter;
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002154 int ret;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002155
2156 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002157 entry = arch_deref_entry_point((void *)*iter);
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002158 ret = kprobe_add_ksym_blacklist(entry);
2159 if (ret == -EINVAL)
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002160 continue;
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002161 if (ret < 0)
2162 return ret;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002163 }
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002164
2165 /* Symbols in __kprobes_text are blacklisted */
2166 ret = kprobe_add_area_blacklist((unsigned long)__kprobes_text_start,
2167 (unsigned long)__kprobes_text_end);
2168
2169 return ret ? : arch_populate_kprobe_blacklist();
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002170}
2171
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002172/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002173static int kprobes_module_callback(struct notifier_block *nb,
2174 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002175{
2176 struct module *mod = data;
2177 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002178 struct kprobe *p;
2179 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002180 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002181
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002182 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002183 return NOTIFY_DONE;
2184
2185 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002186 * When MODULE_STATE_GOING was notified, both of module .text and
2187 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2188 * notified, only .init.text section would be freed. We need to
2189 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002190 */
2191 mutex_lock(&kprobe_mutex);
2192 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2193 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002194 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002195 if (within_module_init((unsigned long)p->addr, mod) ||
2196 (checkcore &&
2197 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002198 /*
2199 * The vaddr this probe is installed will soon
2200 * be vfreed buy not synced to disk. Hence,
2201 * disarming the breakpoint isn't needed.
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002202 *
2203 * Note, this will also move any optimized probes
2204 * that are pending to be removed from their
2205 * corresponding lists to the freeing_list and
2206 * will not be touched by the delayed
2207 * kprobe_optimizer work handler.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002208 */
2209 kill_kprobe(p);
2210 }
2211 }
2212 mutex_unlock(&kprobe_mutex);
2213 return NOTIFY_DONE;
2214}
2215
2216static struct notifier_block kprobe_module_nb = {
2217 .notifier_call = kprobes_module_callback,
2218 .priority = 0
2219};
2220
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002221/* Markers of _kprobe_blacklist section */
2222extern unsigned long __start_kprobe_blacklist[];
2223extern unsigned long __stop_kprobe_blacklist[];
2224
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225static int __init init_kprobes(void)
2226{
2227 int i, err = 0;
2228
2229 /* FIXME allocate the probe table, currently defined statically */
2230 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002231 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002233 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002234 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002235 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002237 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2238 __stop_kprobe_blacklist);
2239 if (err) {
2240 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2241 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002242 }
2243
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002244 if (kretprobe_blacklist_size) {
2245 /* lookup the function address from its name */
2246 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
Naveen N. Rao49e0b462017-04-19 18:21:00 +05302247 kretprobe_blacklist[i].addr =
Naveen N. Rao290e3072017-04-19 18:21:01 +05302248 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002249 if (!kretprobe_blacklist[i].addr)
2250 printk("kretprobe: lookup failed: %s\n",
2251 kretprobe_blacklist[i].name);
2252 }
2253 }
2254
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002255#if defined(CONFIG_OPTPROBES)
2256#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002257 /* Init kprobe_optinsn_slots */
2258 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2259#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002260 /* By default, kprobes can be optimized */
2261 kprobes_allow_optimization = true;
2262#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002263
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002264 /* By default, kprobes are armed */
2265 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002266
Rusty Lynch67729262005-07-05 18:54:50 -07002267 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002268 if (!err)
2269 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002270 if (!err)
2271 err = register_module_notifier(&kprobe_module_nb);
2272
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002273 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002274
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002275 if (!err)
2276 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 return err;
2278}
Masami Hiramatsu65fc9652019-06-03 22:04:42 +09002279subsys_initcall(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280
Srinivasa Ds346fd592007-02-20 13:57:54 -08002281#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002282static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002283 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002284{
2285 char *kprobe_type;
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002286 void *addr = p->addr;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002287
2288 if (p->pre_handler == pre_handler_kretprobe)
2289 kprobe_type = "r";
Srinivasa Ds346fd592007-02-20 13:57:54 -08002290 else
2291 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002292
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002293 if (!kallsyms_show_value())
2294 addr = NULL;
2295
Srinivasa Ds346fd592007-02-20 13:57:54 -08002296 if (sym)
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002297 seq_printf(pi, "%px %s %s+0x%x %s ",
2298 addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002299 (modname ? modname : " "));
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002300 else /* try to use %pS */
2301 seq_printf(pi, "%px %s %pS ",
2302 addr, kprobe_type, p->addr);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002303
2304 if (!pp)
2305 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002306 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002307 (kprobe_gone(p) ? "[GONE]" : ""),
2308 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002309 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2310 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002311}
2312
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002313static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002314{
2315 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2316}
2317
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002318static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002319{
2320 (*pos)++;
2321 if (*pos >= KPROBE_TABLE_SIZE)
2322 return NULL;
2323 return pos;
2324}
2325
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002326static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002327{
2328 /* Nothing to do */
2329}
2330
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002331static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002332{
2333 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002334 struct kprobe *p, *kp;
2335 const char *sym = NULL;
2336 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002337 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002338 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002339
2340 head = &kprobe_table[i];
2341 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002342 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002343 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002344 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002345 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002346 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002347 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002348 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002349 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002350 }
2351 preempt_enable();
2352 return 0;
2353}
2354
James Morris88e9d342009-09-22 16:43:43 -07002355static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002356 .start = kprobe_seq_start,
2357 .next = kprobe_seq_next,
2358 .stop = kprobe_seq_stop,
2359 .show = show_kprobe_addr
2360};
2361
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002362static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002363{
2364 return seq_open(filp, &kprobes_seq_ops);
2365}
2366
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002367static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002368 .open = kprobes_open,
2369 .read = seq_read,
2370 .llseek = seq_lseek,
2371 .release = seq_release,
2372};
2373
Masami Hiramatsu63724742014-04-17 17:18:49 +09002374/* kprobes/blacklist -- shows which functions can not be probed */
2375static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2376{
2377 return seq_list_start(&kprobe_blacklist, *pos);
2378}
2379
2380static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2381{
2382 return seq_list_next(v, &kprobe_blacklist, pos);
2383}
2384
2385static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2386{
2387 struct kprobe_blacklist_entry *ent =
2388 list_entry(v, struct kprobe_blacklist_entry, list);
2389
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002390 /*
2391 * If /proc/kallsyms is not showing kernel address, we won't
2392 * show them here either.
2393 */
2394 if (!kallsyms_show_value())
2395 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2396 (void *)ent->start_addr);
2397 else
2398 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2399 (void *)ent->end_addr, (void *)ent->start_addr);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002400 return 0;
2401}
2402
2403static const struct seq_operations kprobe_blacklist_seq_ops = {
2404 .start = kprobe_blacklist_seq_start,
2405 .next = kprobe_blacklist_seq_next,
2406 .stop = kprobe_seq_stop, /* Reuse void function */
2407 .show = kprobe_blacklist_seq_show,
2408};
2409
2410static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2411{
2412 return seq_open(filp, &kprobe_blacklist_seq_ops);
2413}
2414
2415static const struct file_operations debugfs_kprobe_blacklist_ops = {
2416 .open = kprobe_blacklist_open,
2417 .read = seq_read,
2418 .llseek = seq_lseek,
2419 .release = seq_release,
2420};
2421
Jessica Yu12310e342018-01-10 00:51:23 +01002422static int arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002423{
2424 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002425 struct kprobe *p;
Jessica Yu12310e342018-01-10 00:51:23 +01002426 unsigned int i, total = 0, errors = 0;
2427 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002428
2429 mutex_lock(&kprobe_mutex);
2430
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002431 /* If kprobes are armed, just return */
2432 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002433 goto already_enabled;
2434
Wang Nan977ad482015-02-13 14:40:24 -08002435 /*
2436 * optimize_kprobe() called by arm_kprobe() checks
2437 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2438 * arm_kprobe.
2439 */
2440 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002441 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002442 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2443 head = &kprobe_table[i];
Jessica Yu12310e342018-01-10 00:51:23 +01002444 /* Arm all kprobes on a best-effort basis */
2445 hlist_for_each_entry_rcu(p, head, hlist) {
2446 if (!kprobe_disabled(p)) {
2447 err = arm_kprobe(p);
2448 if (err) {
2449 errors++;
2450 ret = err;
2451 }
2452 total++;
2453 }
2454 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002455 }
2456
Jessica Yu12310e342018-01-10 00:51:23 +01002457 if (errors)
2458 pr_warn("Kprobes globally enabled, but failed to arm %d out of %d probes\n",
2459 errors, total);
2460 else
2461 pr_info("Kprobes globally enabled\n");
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002462
2463already_enabled:
2464 mutex_unlock(&kprobe_mutex);
Jessica Yu12310e342018-01-10 00:51:23 +01002465 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002466}
2467
Jessica Yu297f9232018-01-10 00:51:24 +01002468static int disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002469{
2470 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002471 struct kprobe *p;
Jessica Yu297f9232018-01-10 00:51:24 +01002472 unsigned int i, total = 0, errors = 0;
2473 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002474
2475 mutex_lock(&kprobe_mutex);
2476
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002477 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002478 if (kprobes_all_disarmed) {
2479 mutex_unlock(&kprobe_mutex);
Jessica Yu297f9232018-01-10 00:51:24 +01002480 return 0;
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002481 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002482
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002483 kprobes_all_disarmed = true;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002484
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002485 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2486 head = &kprobe_table[i];
Jessica Yu297f9232018-01-10 00:51:24 +01002487 /* Disarm all kprobes on a best-effort basis */
Sasha Levinb67bfe02013-02-27 17:06:00 -08002488 hlist_for_each_entry_rcu(p, head, hlist) {
Jessica Yu297f9232018-01-10 00:51:24 +01002489 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2490 err = disarm_kprobe(p, false);
2491 if (err) {
2492 errors++;
2493 ret = err;
2494 }
2495 total++;
2496 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002497 }
2498 }
Jessica Yu297f9232018-01-10 00:51:24 +01002499
2500 if (errors)
2501 pr_warn("Kprobes globally disabled, but failed to disarm %d out of %d probes\n",
2502 errors, total);
2503 else
2504 pr_info("Kprobes globally disabled\n");
2505
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002506 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002507
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002508 /* Wait for disarming all kprobes by optimizer */
2509 wait_for_kprobe_optimizer();
Jessica Yu297f9232018-01-10 00:51:24 +01002510
2511 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002512}
2513
2514/*
2515 * XXX: The debugfs bool file interface doesn't allow for callbacks
2516 * when the bool state is switched. We can reuse that facility when
2517 * available
2518 */
2519static ssize_t read_enabled_file_bool(struct file *file,
2520 char __user *user_buf, size_t count, loff_t *ppos)
2521{
2522 char buf[3];
2523
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002524 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002525 buf[0] = '1';
2526 else
2527 buf[0] = '0';
2528 buf[1] = '\n';
2529 buf[2] = 0x00;
2530 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2531}
2532
2533static ssize_t write_enabled_file_bool(struct file *file,
2534 const char __user *user_buf, size_t count, loff_t *ppos)
2535{
2536 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002537 size_t buf_size;
Jessica Yu12310e342018-01-10 00:51:23 +01002538 int ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002539
2540 buf_size = min(count, (sizeof(buf)-1));
2541 if (copy_from_user(buf, user_buf, buf_size))
2542 return -EFAULT;
2543
Mathias Krause10fb46d2013-07-03 15:05:39 -07002544 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002545 switch (buf[0]) {
2546 case 'y':
2547 case 'Y':
2548 case '1':
Jessica Yu12310e342018-01-10 00:51:23 +01002549 ret = arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002550 break;
2551 case 'n':
2552 case 'N':
2553 case '0':
Jessica Yu297f9232018-01-10 00:51:24 +01002554 ret = disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002555 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002556 default:
2557 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002558 }
2559
Jessica Yu12310e342018-01-10 00:51:23 +01002560 if (ret)
2561 return ret;
2562
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002563 return count;
2564}
2565
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002566static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002567 .read = read_enabled_file_bool,
2568 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002569 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002570};
2571
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002572static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002573{
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002574 struct dentry *dir;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002575 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002576
2577 dir = debugfs_create_dir("kprobes", NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002578
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002579 debugfs_create_file("list", 0400, dir, NULL,
2580 &debugfs_kprobes_operations);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002581
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002582 debugfs_create_file("enabled", 0600, dir, &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002583
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002584 debugfs_create_file("blacklist", 0400, dir, NULL,
2585 &debugfs_kprobe_blacklist_ops);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002586
Srinivasa Ds346fd592007-02-20 13:57:54 -08002587 return 0;
2588}
2589
2590late_initcall(debugfs_kprobe_init);
2591#endif /* CONFIG_DEBUG_FS */