blob: 90e98e233647f13dda24630567c520aee08c5e49 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Kernel Probes (KProbes)
3 * kernel/kprobes.c
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 *
19 * Copyright (C) IBM Corporation, 2002, 2004
20 *
21 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
22 * Probes initial implementation (includes suggestions from
23 * Rusty Russell).
24 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
25 * hlists and exceptions notifier as suggested by Andi Kleen.
26 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
27 * interface to access function arguments.
28 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
29 * exceptions notifier to be first on the priority list.
Hien Nguyenb94cce92005-06-23 00:09:19 -070030 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
31 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
32 * <prasanna@in.ibm.com> added function-return probes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 */
34#include <linux/kprobes.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/hash.h>
36#include <linux/init.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080037#include <linux/slab.h>
Randy Dunlape3869792007-05-08 00:27:01 -070038#include <linux/stddef.h>
Paul Gortmaker9984de12011-05-23 14:51:41 -040039#include <linux/export.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070040#include <linux/moduleloader.h>
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070041#include <linux/kallsyms.h>
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080042#include <linux/freezer.h>
Srinivasa Ds346fd592007-02-20 13:57:54 -080043#include <linux/seq_file.h>
44#include <linux/debugfs.h>
Masami Hiramatsub2be84d2010-02-25 08:34:15 -050045#include <linux/sysctl.h>
Christoph Hellwig1eeb66a2007-05-08 00:27:03 -070046#include <linux/kdebug.h>
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -050047#include <linux/memory.h>
Masami Hiramatsu4554dbc2010-02-02 16:49:18 -050048#include <linux/ftrace.h>
Masami Hiramatsuafd66252010-02-25 08:34:07 -050049#include <linux/cpu.h>
Jason Baronbf5438fc2010-09-17 11:09:00 -040050#include <linux/jump_label.h>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070051
Christoph Hellwigbfd45be2016-10-11 13:52:22 -070052#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <asm/cacheflush.h>
54#include <asm/errno.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080055#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57#define KPROBE_HASH_BITS 6
58#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
59
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070060
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070061static int kprobes_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
Hien Nguyenb94cce92005-06-23 00:09:19 -070063static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070065/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070066static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070067
Masami Hiramatsu43948f52010-10-25 22:18:01 +090068/* This protects kprobe_table and optimizing_list */
69static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080070static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070071static struct {
Thomas Gleixnerec4846082009-07-25 16:09:17 +020072 raw_spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070073} kretprobe_table_locks[KPROBE_TABLE_SIZE];
74
Naveen N. Rao290e3072017-04-19 18:21:01 +053075kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
76 unsigned int __unused)
Naveen N. Rao49e0b462017-04-19 18:21:00 +053077{
78 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
79}
80
Thomas Gleixnerec4846082009-07-25 16:09:17 +020081static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070082{
83 return &(kretprobe_table_locks[hash].lock);
84}
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Masami Hiramatsu376e2422014-04-17 17:17:05 +090086/* Blacklist -- list of struct kprobe_blacklist_entry */
87static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070088
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080089#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070090/*
91 * kprobe->ainsn.insn points to the copy of the instruction to be
92 * single-stepped. x86_64, POWER4 and above have no-exec support and
93 * stepping on the instruction on a vmalloced/kmalloced/data page
94 * is a recipe for disaster
95 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070096struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -040097 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070098 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -070099 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700100 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800101 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500102 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700103};
104
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500105#define KPROBE_INSN_PAGE_SIZE(slots) \
106 (offsetof(struct kprobe_insn_page, slot_used) + \
107 (sizeof(char) * (slots)))
108
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500109static int slots_per_page(struct kprobe_insn_cache *c)
110{
111 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
112}
113
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800114enum kprobe_slot_state {
115 SLOT_CLEAN = 0,
116 SLOT_DIRTY = 1,
117 SLOT_USED = 2,
118};
119
Masami Hiramatsu63fef142017-08-18 17:24:00 +0900120void __weak *alloc_insn_page(void)
Heiko Carstensaf963972013-09-11 14:24:13 -0700121{
122 return module_alloc(PAGE_SIZE);
123}
124
Masami Hiramatsuc93f5cf2017-05-25 19:38:17 +0900125void __weak free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700126{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030127 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700128}
129
Heiko Carstensc802d642013-09-11 14:24:11 -0700130struct kprobe_insn_cache kprobe_insn_slots = {
131 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700132 .alloc = alloc_insn_page,
133 .free = free_insn_page,
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500134 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
135 .insn_size = MAX_INSN_SIZE,
136 .nr_garbage = 0,
137};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900138static int collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800139
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700140/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800141 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700142 * We allocate an executable page if there's no room on existing ones.
143 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900144kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700145{
146 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700147 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700148
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900149 /* Since the slot array is not protected by rcu, we need a mutex */
Heiko Carstensc802d642013-09-11 14:24:11 -0700150 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700151 retry:
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900152 rcu_read_lock();
153 list_for_each_entry_rcu(kip, &c->pages, list) {
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500154 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700155 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500156 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800157 if (kip->slot_used[i] == SLOT_CLEAN) {
158 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700159 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700160 slot = kip->insns + (i * c->insn_size);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900161 rcu_read_unlock();
Heiko Carstensc802d642013-09-11 14:24:11 -0700162 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700163 }
164 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500165 /* kip->nused is broken. Fix it. */
166 kip->nused = slots_per_page(c);
167 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700168 }
169 }
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900170 rcu_read_unlock();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700171
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800172 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500173 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800174 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500175
176 /* All out of space. Need to allocate a new page. */
177 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700178 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700179 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700180
181 /*
182 * Use module_alloc so this page is within +/- 2GB of where the
183 * kernel image and loaded module images reside. This is required
184 * so x86_64 can correctly handle the %rip-relative fixups.
185 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700186 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700187 if (!kip->insns) {
188 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700189 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700190 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400191 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500192 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800193 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700194 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800195 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700196 kip->cache = c;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900197 list_add_rcu(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700198 slot = kip->insns;
199out:
200 mutex_unlock(&c->mutex);
201 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800202}
203
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800204/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900205static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800206{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800207 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800208 kip->nused--;
209 if (kip->nused == 0) {
210 /*
211 * Page is no longer in use. Free it unless
212 * it's the last one. We keep the last one
213 * so as not to have to set it up again the
214 * next time somebody inserts a probe.
215 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500216 if (!list_is_singular(&kip->list)) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900217 list_del_rcu(&kip->list);
218 synchronize_rcu();
Heiko Carstensaf963972013-09-11 14:24:13 -0700219 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800220 kfree(kip);
221 }
222 return 1;
223 }
224 return 0;
225}
226
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900227static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800228{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400229 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800230
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500231 /* Ensure no-one is interrupted on the garbages */
232 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500234 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800235 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800236 if (kip->ngarbage == 0)
237 continue;
238 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500239 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900240 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800241 break;
242 }
243 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500244 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800245 return 0;
246}
247
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900248void __free_insn_slot(struct kprobe_insn_cache *c,
249 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500250{
251 struct kprobe_insn_page *kip;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900252 long idx;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500253
Heiko Carstensc802d642013-09-11 14:24:11 -0700254 mutex_lock(&c->mutex);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900255 rcu_read_lock();
256 list_for_each_entry_rcu(kip, &c->pages, list) {
257 idx = ((long)slot - (long)kip->insns) /
258 (c->insn_size * sizeof(kprobe_opcode_t));
259 if (idx >= 0 && idx < slots_per_page(c))
Heiko Carstensc802d642013-09-11 14:24:11 -0700260 goto out;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900261 }
262 /* Could not find this slot. */
263 WARN_ON(1);
264 kip = NULL;
265out:
266 rcu_read_unlock();
267 /* Mark and sweep: this may sleep */
268 if (kip) {
269 /* Check double free */
270 WARN_ON(kip->slot_used[idx] != SLOT_USED);
271 if (dirty) {
272 kip->slot_used[idx] = SLOT_DIRTY;
273 kip->ngarbage++;
274 if (++c->nr_garbage > slots_per_page(c))
275 collect_garbage_slots(c);
276 } else {
277 collect_one_slot(kip, idx);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500278 }
279 }
Heiko Carstensc802d642013-09-11 14:24:11 -0700280 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500281}
282
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900283/*
284 * Check given address is on the page of kprobe instruction slots.
285 * This will be used for checking whether the address on a stack
286 * is on a text area or not.
287 */
288bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
289{
290 struct kprobe_insn_page *kip;
291 bool ret = false;
292
293 rcu_read_lock();
294 list_for_each_entry_rcu(kip, &c->pages, list) {
295 if (addr >= (unsigned long)kip->insns &&
296 addr < (unsigned long)kip->insns + PAGE_SIZE) {
297 ret = true;
298 break;
299 }
300 }
301 rcu_read_unlock();
302
303 return ret;
304}
305
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500306#ifdef CONFIG_OPTPROBES
307/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700308struct kprobe_insn_cache kprobe_optinsn_slots = {
309 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700310 .alloc = alloc_insn_page,
311 .free = free_insn_page,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500312 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
313 /* .insn_size is initialized later */
314 .nr_garbage = 0,
315};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500316#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800317#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700318
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800319/* We have preemption disabled.. so it is safe to use __ versions */
320static inline void set_kprobe_instance(struct kprobe *kp)
321{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600322 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800323}
324
325static inline void reset_kprobe_instance(void)
326{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600327 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800328}
329
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800330/*
331 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800332 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800333 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800334 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800335 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900336struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
338 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800339 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800342 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 if (p->addr == addr)
344 return p;
345 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 return NULL;
348}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900349NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900351static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500352
353/* Return true if the kprobe is an aggregator */
354static inline int kprobe_aggrprobe(struct kprobe *p)
355{
356 return p->pre_handler == aggr_pre_handler;
357}
358
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900359/* Return true(!0) if the kprobe is unused */
360static inline int kprobe_unused(struct kprobe *p)
361{
362 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
363 list_empty(&p->list);
364}
365
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500366/*
367 * Keep all fields in the kprobe consistent
368 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900369static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500370{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900371 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
372 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500373}
374
375#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500376/* NOTE: change this value only with kprobe_mutex held */
377static bool kprobes_allow_optimization;
378
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500379/*
380 * Call all pre_handler on the list, but ignores its return value.
381 * This must be called from arch-dep optimized caller.
382 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900383void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500384{
385 struct kprobe *kp;
386
387 list_for_each_entry_rcu(kp, &p->list, list) {
388 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
389 set_kprobe_instance(kp);
Naveen N. Rao4f3a8712017-10-17 13:48:34 +0530390 kp->pre_handler(kp, regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500391 }
392 reset_kprobe_instance();
393 }
394}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900395NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500396
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900397/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900398static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900399{
400 struct optimized_kprobe *op;
401
402 op = container_of(p, struct optimized_kprobe, kp);
403 arch_remove_optimized_kprobe(op);
404 arch_remove_kprobe(p);
405 kfree(op);
406}
407
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500408/* Return true(!0) if the kprobe is ready for optimization. */
409static inline int kprobe_optready(struct kprobe *p)
410{
411 struct optimized_kprobe *op;
412
413 if (kprobe_aggrprobe(p)) {
414 op = container_of(p, struct optimized_kprobe, kp);
415 return arch_prepared_optinsn(&op->optinsn);
416 }
417
418 return 0;
419}
420
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900421/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
422static inline int kprobe_disarmed(struct kprobe *p)
423{
424 struct optimized_kprobe *op;
425
426 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
427 if (!kprobe_aggrprobe(p))
428 return kprobe_disabled(p);
429
430 op = container_of(p, struct optimized_kprobe, kp);
431
432 return kprobe_disabled(p) && list_empty(&op->list);
433}
434
435/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900436static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900437{
438 struct optimized_kprobe *op;
439
440 if (kprobe_aggrprobe(p)) {
441 op = container_of(p, struct optimized_kprobe, kp);
442 if (!list_empty(&op->list))
443 return 1;
444 }
445 return 0;
446}
447
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500448/*
449 * Return an optimized kprobe whose optimizing code replaces
450 * instructions including addr (exclude breakpoint).
451 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900452static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500453{
454 int i;
455 struct kprobe *p = NULL;
456 struct optimized_kprobe *op;
457
458 /* Don't check i == 0, since that is a breakpoint case. */
459 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
460 p = get_kprobe((void *)(addr - i));
461
462 if (p && kprobe_optready(p)) {
463 op = container_of(p, struct optimized_kprobe, kp);
464 if (arch_within_optimized_kprobe(op, addr))
465 return p;
466 }
467
468 return NULL;
469}
470
471/* Optimization staging list, protected by kprobe_mutex */
472static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900473static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900474static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500475
476static void kprobe_optimizer(struct work_struct *work);
477static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
478#define OPTIMIZE_DELAY 5
479
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900480/*
481 * Optimize (replace a breakpoint with a jump) kprobes listed on
482 * optimizing_list.
483 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900484static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500485{
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500486 /*
487 * The optimization/unoptimization refers online_cpus via
488 * stop_machine() and cpu-hotplug modifies online_cpus.
489 * And same time, text_mutex will be held in cpu-hotplug and here.
490 * This combination can cause a deadlock (cpu-hotplug try to lock
491 * text_mutex but stop_machine can not be done because online_cpus
492 * has been changed)
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200493 * To avoid this deadlock, caller must have locked cpu hotplug
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500494 * for preventing cpu-hotplug outside of text_mutex locking.
495 */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200496 lockdep_assert_cpus_held();
497
498 /* Optimization never be done when disarmed */
499 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
500 list_empty(&optimizing_list))
501 return;
502
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500503 mutex_lock(&text_mutex);
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900504 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500505 mutex_unlock(&text_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900506}
507
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900508/*
509 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
510 * if need) kprobes listed on unoptimizing_list.
511 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900512static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900513{
514 struct optimized_kprobe *op, *tmp;
515
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200516 /* See comment in do_optimize_kprobes() */
517 lockdep_assert_cpus_held();
518
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900519 /* Unoptimization must be done anytime */
520 if (list_empty(&unoptimizing_list))
521 return;
522
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900523 mutex_lock(&text_mutex);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900524 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900525 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900526 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900527 /* Disarm probes if marked disabled */
528 if (kprobe_disabled(&op->kp))
529 arch_disarm_kprobe(&op->kp);
530 if (kprobe_unused(&op->kp)) {
531 /*
532 * Remove unused probes from hash list. After waiting
533 * for synchronization, these probes are reclaimed.
534 * (reclaiming is done by do_free_cleaned_kprobes.)
535 */
536 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900537 } else
538 list_del_init(&op->list);
539 }
540 mutex_unlock(&text_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900541}
542
543/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900544static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900545{
546 struct optimized_kprobe *op, *tmp;
547
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900548 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900549 list_del_init(&op->list);
Masami Hiramatsucbdd96f2018-09-11 19:21:09 +0900550 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
551 /*
552 * This must not happen, but if there is a kprobe
553 * still in use, keep it on kprobes hash list.
554 */
555 continue;
556 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900557 free_aggr_kprobe(&op->kp);
558 }
559}
560
561/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900562static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900563{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800564 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900565}
566
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900567/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900568static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900569{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900570 mutex_lock(&kprobe_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200571 cpus_read_lock();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900572 /* Lock modules while optimizing kprobes */
573 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900574
575 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900576 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
577 * kprobes before waiting for quiesence period.
578 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900579 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900580
581 /*
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900582 * Step 2: Wait for quiesence period to ensure all potentially
583 * preempted tasks to have normally scheduled. Because optprobe
584 * may modify multiple instructions, there is a chance that Nth
585 * instruction is preempted. In that case, such tasks can return
586 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
587 * Note that on non-preemptive kernel, this is transparently converted
588 * to synchronoze_sched() to wait for all interrupts to have completed.
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900589 */
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900590 synchronize_rcu_tasks();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900591
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900592 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900593 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900594
595 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900596 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900597
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500598 mutex_unlock(&module_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200599 cpus_read_unlock();
Steven Rostedt72ef3792012-06-05 19:28:14 +0900600 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900601
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900602 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900603 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900604 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900605}
606
607/* Wait for completing optimization and unoptimization */
Thomas Gleixner30e7d8942017-05-17 10:19:49 +0200608void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900609{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800610 mutex_lock(&kprobe_mutex);
611
612 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
613 mutex_unlock(&kprobe_mutex);
614
615 /* this will also make optimizing_work execute immmediately */
616 flush_delayed_work(&optimizing_work);
617 /* @optimizing_work might not have been queued yet, relax */
618 cpu_relax();
619
620 mutex_lock(&kprobe_mutex);
621 }
622
623 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500624}
625
626/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900627static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500628{
629 struct optimized_kprobe *op;
630
631 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500632 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500633 (kprobe_disabled(p) || kprobes_all_disarmed))
634 return;
635
Masami Hiramatsu059053a2018-06-20 01:10:27 +0900636 /* kprobes with post_handler can not be optimized */
637 if (p->post_handler)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500638 return;
639
640 op = container_of(p, struct optimized_kprobe, kp);
641
642 /* Check there is no other kprobes at the optimized instructions */
643 if (arch_check_optimized_kprobe(op) < 0)
644 return;
645
646 /* Check if it is already optimized. */
647 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
648 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500649 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900650
651 if (!list_empty(&op->list))
652 /* This is under unoptimizing. Just dequeue the probe */
653 list_del_init(&op->list);
654 else {
655 list_add(&op->list, &optimizing_list);
656 kick_kprobe_optimizer();
657 }
658}
659
660/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900661static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900662{
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200663 lockdep_assert_cpus_held();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900664 arch_unoptimize_kprobe(op);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900665 if (kprobe_disabled(&op->kp))
666 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500667}
668
669/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900670static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500671{
672 struct optimized_kprobe *op;
673
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900674 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
675 return; /* This is not an optprobe nor optimized */
676
677 op = container_of(p, struct optimized_kprobe, kp);
678 if (!kprobe_optimized(p)) {
679 /* Unoptimized or unoptimizing case */
680 if (force && !list_empty(&op->list)) {
681 /*
682 * Only if this is unoptimizing kprobe and forced,
683 * forcibly unoptimize it. (No need to unoptimize
684 * unoptimized kprobe again :)
685 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500686 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900687 force_unoptimize_kprobe(op);
688 }
689 return;
690 }
691
692 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
693 if (!list_empty(&op->list)) {
694 /* Dequeue from the optimization queue */
695 list_del_init(&op->list);
696 return;
697 }
698 /* Optimized kprobe case */
699 if (force)
700 /* Forcibly update the code: this is a special case */
701 force_unoptimize_kprobe(op);
702 else {
703 list_add(&op->list, &unoptimizing_list);
704 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500705 }
706}
707
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900708/* Cancel unoptimizing for reusing */
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900709static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900710{
711 struct optimized_kprobe *op;
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900712 int ret;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900713
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900714 /*
715 * Unused kprobe MUST be on the way of delayed unoptimizing (means
716 * there is still a relative jump) and disabled.
717 */
718 op = container_of(ap, struct optimized_kprobe, kp);
Masami Hiramatsu44585152018-04-28 21:36:33 +0900719 WARN_ON_ONCE(list_empty(&op->list));
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900720 /* Enable the probe again */
721 ap->flags &= ~KPROBE_FLAG_DISABLED;
722 /* Optimize it again (remove from op->list) */
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900723 ret = kprobe_optready(ap);
724 if (ret)
725 return ret;
726
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900727 optimize_kprobe(ap);
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900728 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900729}
730
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500731/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900732static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500733{
734 struct optimized_kprobe *op;
735
736 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900737 if (!list_empty(&op->list))
738 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500739 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900740 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900741
742 if (kprobe_unused(p)) {
743 /* Enqueue if it is unused */
744 list_add(&op->list, &freeing_list);
745 /*
746 * Remove unused probes from the hash list. After waiting
747 * for synchronization, this probe is reclaimed.
748 * (reclaiming is done by do_free_cleaned_kprobes().)
749 */
750 hlist_del_rcu(&op->kp.hlist);
751 }
752
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900753 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500754 arch_remove_optimized_kprobe(op);
755}
756
Masami Hiramatsua4602462017-04-19 18:22:25 +0530757static inline
758void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
759{
760 if (!kprobe_ftrace(p))
761 arch_prepare_optimized_kprobe(op, p);
762}
763
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500764/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900765static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500766{
767 struct optimized_kprobe *op;
768
769 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530770 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500771}
772
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500773/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900774static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500775{
776 struct optimized_kprobe *op;
777
778 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
779 if (!op)
780 return NULL;
781
782 INIT_LIST_HEAD(&op->list);
783 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530784 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500785
786 return &op->kp;
787}
788
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900789static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500790
791/*
792 * Prepare an optimized_kprobe and optimize it
793 * NOTE: p must be a normal registered kprobe
794 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900795static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500796{
797 struct kprobe *ap;
798 struct optimized_kprobe *op;
799
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900800 /* Impossible to optimize ftrace-based kprobe */
801 if (kprobe_ftrace(p))
802 return;
803
Masami Hiramatsu25764282012-06-05 19:28:26 +0900804 /* For preparing optimization, jump_label_text_reserved() is called */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200805 cpus_read_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +0900806 jump_label_lock();
807 mutex_lock(&text_mutex);
808
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500809 ap = alloc_aggr_kprobe(p);
810 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900811 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500812
813 op = container_of(ap, struct optimized_kprobe, kp);
814 if (!arch_prepared_optinsn(&op->optinsn)) {
815 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900816 arch_remove_optimized_kprobe(op);
817 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900818 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500819 }
820
821 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900822 optimize_kprobe(ap); /* This just kicks optimizer thread */
823
824out:
825 mutex_unlock(&text_mutex);
826 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200827 cpus_read_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500828}
829
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500830#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900831static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500832{
833 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500834 struct kprobe *p;
835 unsigned int i;
836
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900837 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500838 /* If optimization is already allowed, just return */
839 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900840 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500841
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200842 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500843 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500844 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
845 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800846 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500847 if (!kprobe_disabled(p))
848 optimize_kprobe(p);
849 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200850 cpus_read_unlock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500851 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900852out:
853 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500854}
855
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900856static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500857{
858 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500859 struct kprobe *p;
860 unsigned int i;
861
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900862 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500863 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900864 if (!kprobes_allow_optimization) {
865 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500866 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900867 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500868
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200869 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500870 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500871 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
872 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800873 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500874 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900875 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500876 }
877 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200878 cpus_read_unlock();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900879 mutex_unlock(&kprobe_mutex);
880
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900881 /* Wait for unoptimizing completion */
882 wait_for_kprobe_optimizer();
883 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500884}
885
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900886static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500887int sysctl_kprobes_optimization;
888int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
889 void __user *buffer, size_t *length,
890 loff_t *ppos)
891{
892 int ret;
893
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900894 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500895 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
896 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
897
898 if (sysctl_kprobes_optimization)
899 optimize_all_kprobes();
900 else
901 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900902 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500903
904 return ret;
905}
906#endif /* CONFIG_SYSCTL */
907
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900908/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900909static void __arm_kprobe(struct kprobe *p)
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
913 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900914 _p = get_optimized_kprobe((unsigned long)p->addr);
915 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900916 /* Fallback to unoptimized kprobe */
917 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500918
919 arch_arm_kprobe(p);
920 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
921}
922
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900923/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900924static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500925{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900926 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500927
Wang Nan69d54b92015-02-13 14:40:26 -0800928 /* Try to unoptimize */
929 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500930
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900931 if (!kprobe_queued(p)) {
932 arch_disarm_kprobe(p);
933 /* If another kprobe was blocked, optimize it. */
934 _p = get_optimized_kprobe((unsigned long)p->addr);
935 if (unlikely(_p) && reopt)
936 optimize_kprobe(_p);
937 }
938 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500939}
940
941#else /* !CONFIG_OPTPROBES */
942
943#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900944#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500945#define kill_optimized_kprobe(p) do {} while (0)
946#define prepare_optimized_kprobe(p) do {} while (0)
947#define try_to_optimize_kprobe(p) do {} while (0)
948#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900949#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
950#define kprobe_disarmed(p) kprobe_disabled(p)
951#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500952
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900953static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900954{
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900955 /*
956 * If the optimized kprobe is NOT supported, the aggr kprobe is
957 * released at the same time that the last aggregated kprobe is
958 * unregistered.
959 * Thus there should be no chance to reuse unused kprobe.
960 */
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900961 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900962 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900963}
964
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900965static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500966{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900967 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500968 kfree(p);
969}
970
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900971static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500972{
973 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
974}
975#endif /* CONFIG_OPTPROBES */
976
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900977#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900978static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900979 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500980 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900981};
982static int kprobe_ftrace_enabled;
983
984/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900985static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900986{
987 if (!kprobe_ftrace(p))
988 return arch_prepare_kprobe(p);
989
990 return arch_prepare_kprobe_ftrace(p);
991}
992
993/* Caller must lock kprobe_mutex */
Jessica Yu12310e342018-01-10 00:51:23 +0100994static int arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900995{
Jessica Yu12310e342018-01-10 00:51:23 +0100996 int ret = 0;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900997
998 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
999 (unsigned long)p->addr, 0, 0);
Jessica Yu12310e342018-01-10 00:51:23 +01001000 if (ret) {
Masami Hiramatsu44585152018-04-28 21:36:33 +09001001 pr_debug("Failed to arm kprobe-ftrace at %pS (%d)\n",
1002 p->addr, ret);
Jessica Yu12310e342018-01-10 00:51:23 +01001003 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001004 }
Jessica Yu12310e342018-01-10 00:51:23 +01001005
1006 if (kprobe_ftrace_enabled == 0) {
1007 ret = register_ftrace_function(&kprobe_ftrace_ops);
1008 if (ret) {
1009 pr_debug("Failed to init kprobe-ftrace (%d)\n", ret);
1010 goto err_ftrace;
1011 }
1012 }
1013
1014 kprobe_ftrace_enabled++;
1015 return ret;
1016
1017err_ftrace:
1018 /*
1019 * Note: Since kprobe_ftrace_ops has IPMODIFY set, and ftrace requires a
1020 * non-empty filter_hash for IPMODIFY ops, we're safe from an accidental
1021 * empty filter_hash which would undesirably trace all functions.
1022 */
1023 ftrace_set_filter_ip(&kprobe_ftrace_ops, (unsigned long)p->addr, 1, 0);
1024 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001025}
1026
1027/* Caller must lock kprobe_mutex */
Jessica Yu297f9232018-01-10 00:51:24 +01001028static int disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001029{
Jessica Yu297f9232018-01-10 00:51:24 +01001030 int ret = 0;
1031
1032 if (kprobe_ftrace_enabled == 1) {
1033 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
1034 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (%d)\n", ret))
1035 return ret;
1036 }
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001037
1038 kprobe_ftrace_enabled--;
Jessica Yu297f9232018-01-10 00:51:24 +01001039
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001040 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1041 (unsigned long)p->addr, 1, 0);
Masami Hiramatsu44585152018-04-28 21:36:33 +09001042 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (%d)\n",
1043 p->addr, ret);
Jessica Yu297f9232018-01-10 00:51:24 +01001044 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001045}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001046#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001047#define prepare_kprobe(p) arch_prepare_kprobe(p)
Jessica Yu12310e342018-01-10 00:51:23 +01001048#define arm_kprobe_ftrace(p) (-ENODEV)
Jessica Yu297f9232018-01-10 00:51:24 +01001049#define disarm_kprobe_ftrace(p) (-ENODEV)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001050#endif
1051
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001052/* Arm a kprobe with text_mutex */
Jessica Yu12310e342018-01-10 00:51:23 +01001053static int arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001054{
Jessica Yu12310e342018-01-10 00:51:23 +01001055 if (unlikely(kprobe_ftrace(kp)))
1056 return arm_kprobe_ftrace(kp);
1057
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001058 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001059 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001060 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001061 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001062 cpus_read_unlock();
Jessica Yu12310e342018-01-10 00:51:23 +01001063
1064 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001065}
1066
1067/* Disarm a kprobe with text_mutex */
Jessica Yu297f9232018-01-10 00:51:24 +01001068static int disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001069{
Jessica Yu297f9232018-01-10 00:51:24 +01001070 if (unlikely(kprobe_ftrace(kp)))
1071 return disarm_kprobe_ftrace(kp);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001072
1073 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001074 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001075 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001076 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001077 cpus_read_unlock();
Jessica Yu297f9232018-01-10 00:51:24 +01001078
1079 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001080}
1081
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001082/*
1083 * Aggregate handlers for multiple kprobes support - these handlers
1084 * take care of invoking the individual kprobe handlers on p->list
1085 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001086static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001087{
1088 struct kprobe *kp;
1089
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001090 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001091 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001092 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001093 if (kp->pre_handler(kp, regs))
1094 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001095 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001096 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001097 }
1098 return 0;
1099}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001100NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001101
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001102static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1103 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001104{
1105 struct kprobe *kp;
1106
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001107 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001108 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001109 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001110 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001111 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001112 }
1113 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001114}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001115NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001116
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001117static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1118 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001119{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001120 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001121
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001122 /*
1123 * if we faulted "during" the execution of a user specified
1124 * probe handler, invoke just that probe's fault handler
1125 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001126 if (cur && cur->fault_handler) {
1127 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001128 return 1;
1129 }
1130 return 0;
1131}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001132NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001133
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001134/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001135void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001136{
1137 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001138 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001139 p->nmissed++;
1140 } else {
1141 list_for_each_entry_rcu(kp, &p->list, list)
1142 kp->nmissed++;
1143 }
1144 return;
1145}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001146NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001147
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001148void recycle_rp_inst(struct kretprobe_instance *ri,
1149 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001150{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001151 struct kretprobe *rp = ri->rp;
1152
Hien Nguyenb94cce92005-06-23 00:09:19 -07001153 /* remove rp inst off the rprobe_inst_table */
1154 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001155 INIT_HLIST_NODE(&ri->hlist);
1156 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001157 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001158 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001159 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001160 } else
1161 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001162 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001163}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001164NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001165
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001166void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001167 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001168__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001169{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001170 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001171 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001172
1173 *head = &kretprobe_inst_table[hash];
1174 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001175 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001176}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001177NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001178
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001179static void kretprobe_table_lock(unsigned long hash,
1180 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001181__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001182{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001183 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1184 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001185}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001186NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001187
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001188void kretprobe_hash_unlock(struct task_struct *tsk,
1189 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001190__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001191{
1192 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001193 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001194
1195 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001196 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001197}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001198NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001199
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001200static void kretprobe_table_unlock(unsigned long hash,
1201 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001202__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001203{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001204 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1205 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001206}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001207NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001208
Hien Nguyenb94cce92005-06-23 00:09:19 -07001209/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001210 * This function is called from finish_task_switch when task tk becomes dead,
1211 * so that we can recycle any function-return probe instances associated
1212 * with this task. These left over instances represent probed functions
1213 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001214 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001215void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001216{
bibo,mao62c27be2006-10-02 02:17:33 -07001217 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001218 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001219 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001220 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001221
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001222 if (unlikely(!kprobes_initialized))
1223 /* Early boot. kretprobe_table_locks not yet initialized. */
1224 return;
1225
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001226 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001227 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1228 head = &kretprobe_inst_table[hash];
1229 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001230 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001231 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001232 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001233 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001234 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001235 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001236 hlist_del(&ri->hlist);
1237 kfree(ri);
1238 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001239}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001240NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001241
Hien Nguyenb94cce92005-06-23 00:09:19 -07001242static inline void free_rp_inst(struct kretprobe *rp)
1243{
1244 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001245 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001246
Sasha Levinb67bfe02013-02-27 17:06:00 -08001247 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001248 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001249 kfree(ri);
1250 }
1251}
1252
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001253static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001254{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001255 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001256 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001257 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001258 struct hlist_head *head;
1259
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001260 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001261 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1262 kretprobe_table_lock(hash, &flags);
1263 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001264 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001265 if (ri->rp == rp)
1266 ri->rp = NULL;
1267 }
1268 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001269 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001270 free_rp_inst(rp);
1271}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001272NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001273
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001274/* Add the new probe to ap->list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001275static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001276{
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001277 if (p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001278 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001279
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001280 list_add_rcu(&p->list, &ap->list);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001281 if (p->post_handler && !ap->post_handler)
1282 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001283
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001284 return 0;
1285}
1286
1287/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001288 * Fill in the required fields of the "manager kprobe". Replace the
1289 * earlier kprobe in the hlist with the manager kprobe
1290 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001291static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001292{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001293 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001294 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001295 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001296 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001297 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001298 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001299 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001300 /* We don't care the kprobe which has gone. */
1301 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001302 ap->post_handler = aggr_post_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001303
1304 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001305 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001306
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001307 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001308 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001309}
1310
1311/*
1312 * This is the second or subsequent kprobe at the address - handle
1313 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001314 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001315static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001316{
1317 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001318 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001319
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001320 cpus_read_lock();
1321
Masami Hiramatsu25764282012-06-05 19:28:26 +09001322 /* For preparing optimization, jump_label_text_reserved() is called */
1323 jump_label_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001324 mutex_lock(&text_mutex);
1325
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001326 if (!kprobe_aggrprobe(orig_p)) {
1327 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1328 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001329 if (!ap) {
1330 ret = -ENOMEM;
1331 goto out;
1332 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001333 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001334 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001335 /* This probe is going to die. Rescue it */
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001336 ret = reuse_unused_kprobe(ap);
1337 if (ret)
1338 goto out;
1339 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001340
1341 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001342 /*
1343 * Attempting to insert new probe at the same location that
1344 * had a probe in the module vaddr area which already
1345 * freed. So, the instruction slot has already been
1346 * released. We need a new slot for the new probe.
1347 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001348 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001349 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001350 /*
1351 * Even if fail to allocate new slot, don't need to
1352 * free aggr_probe. It will be used next time, or
1353 * freed by unregister_kprobe.
1354 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001355 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001356
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001357 /* Prepare optimized instructions if possible. */
1358 prepare_optimized_kprobe(ap);
1359
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001360 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001361 * Clear gone flag to prevent allocating new slot again, and
1362 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001363 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001364 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1365 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001366 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001367
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001368 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001369 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001370 ret = add_new_kprobe(ap, p);
1371
1372out:
1373 mutex_unlock(&text_mutex);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001374 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001375 cpus_read_unlock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001376
1377 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1378 ap->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01001379 if (!kprobes_all_disarmed) {
Masami Hiramatsu25764282012-06-05 19:28:26 +09001380 /* Arm the breakpoint again. */
Jessica Yu12310e342018-01-10 00:51:23 +01001381 ret = arm_kprobe(ap);
1382 if (ret) {
1383 ap->flags |= KPROBE_FLAG_DISABLED;
1384 list_del_rcu(&p->list);
1385 synchronize_sched();
1386 }
1387 }
Masami Hiramatsu25764282012-06-05 19:28:26 +09001388 }
1389 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001390}
1391
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001392bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1393{
1394 /* The __kprobes marked functions and entry code must not be probed */
1395 return addr >= (unsigned long)__kprobes_text_start &&
1396 addr < (unsigned long)__kprobes_text_end;
1397}
1398
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001399bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001400{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001401 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001402
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001403 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001404 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001405 /*
1406 * If there exists a kprobe_blacklist, verify and
1407 * fail any probe registration in the prohibited area
1408 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001409 list_for_each_entry(ent, &kprobe_blacklist, list) {
1410 if (addr >= ent->start_addr && addr < ent->end_addr)
1411 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001412 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001413
1414 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001415}
1416
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001417/*
1418 * If we have a symbol_name argument, look it up and add the offset field
1419 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001420 * This returns encoded errors if it fails to look up symbol or invalid
1421 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001422 */
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301423static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1424 const char *symbol_name, unsigned int offset)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001425{
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301426 if ((symbol_name && addr) || (!symbol_name && !addr))
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001427 goto invalid;
1428
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301429 if (symbol_name) {
Linus Torvalds7246f602017-05-05 11:36:44 -07001430 addr = kprobe_lookup_name(symbol_name, offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001431 if (!addr)
1432 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001433 }
1434
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301435 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001436 if (addr)
1437 return addr;
1438
1439invalid:
1440 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001441}
1442
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301443static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1444{
1445 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1446}
1447
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301448/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001449static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301450{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001451 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301452
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001453 ap = get_kprobe(p->addr);
1454 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301455 return NULL;
1456
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001457 if (p != ap) {
1458 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301459 if (list_p == p)
1460 /* kprobe p is a valid probe */
1461 goto valid;
1462 return NULL;
1463 }
1464valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001465 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301466}
1467
1468/* Return error if the kprobe is being re-registered */
1469static inline int check_kprobe_rereg(struct kprobe *p)
1470{
1471 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301472
1473 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001474 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301475 ret = -EINVAL;
1476 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001477
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301478 return ret;
1479}
1480
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001481int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001483 unsigned long ftrace_addr;
1484
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001485 ftrace_addr = ftrace_location((unsigned long)p->addr);
1486 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001487#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001488 /* Given address is not on the instruction boundary */
1489 if ((unsigned long)p->addr != ftrace_addr)
1490 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001491 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001492#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001493 return -EINVAL;
1494#endif
1495 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001496 return 0;
1497}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001498
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001499static int check_kprobe_address_safe(struct kprobe *p,
1500 struct module **probed_mod)
1501{
1502 int ret;
1503
1504 ret = arch_check_ftrace_location(p);
1505 if (ret)
1506 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001507 jump_label_lock();
1508 preempt_disable();
1509
1510 /* Ensure it is not in reserved area nor out of text */
1511 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001512 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001513 jump_label_text_reserved(p->addr, p->addr)) {
1514 ret = -EINVAL;
1515 goto out;
1516 }
1517
1518 /* Check if are we probing a module */
1519 *probed_mod = __module_text_address((unsigned long) p->addr);
1520 if (*probed_mod) {
1521 /*
1522 * We must hold a refcount of the probed module while updating
1523 * its code to prohibit unexpected unloading.
1524 */
1525 if (unlikely(!try_module_get(*probed_mod))) {
1526 ret = -ENOENT;
1527 goto out;
1528 }
1529
1530 /*
1531 * If the module freed .init.text, we couldn't insert
1532 * kprobes in there.
1533 */
1534 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1535 (*probed_mod)->state != MODULE_STATE_COMING) {
1536 module_put(*probed_mod);
1537 *probed_mod = NULL;
1538 ret = -ENOENT;
1539 }
1540 }
1541out:
1542 preempt_enable();
1543 jump_label_unlock();
1544
1545 return ret;
1546}
1547
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001548int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001549{
1550 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001551 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001552 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001553 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001555 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001556 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001557 if (IS_ERR(addr))
1558 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001559 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001560
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301561 ret = check_kprobe_rereg(p);
1562 if (ret)
1563 return ret;
1564
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001565 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1566 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001567 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001568 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001569
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001570 ret = check_kprobe_address_safe(p, &probed_mod);
1571 if (ret)
1572 return ret;
1573
1574 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001575
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001576 old_p = get_kprobe(p->addr);
1577 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001578 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001579 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 goto out;
1581 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001583 cpus_read_lock();
1584 /* Prevent text modification */
1585 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001586 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001587 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001588 cpus_read_unlock();
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001589 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001590 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001591
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001592 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001593 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1595
Jessica Yu12310e342018-01-10 00:51:23 +01001596 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1597 ret = arm_kprobe(p);
1598 if (ret) {
1599 hlist_del_rcu(&p->hlist);
1600 synchronize_sched();
1601 goto out;
1602 }
1603 }
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001604
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001605 /* Try to optimize kprobe */
1606 try_to_optimize_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001608 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001609
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001610 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001611 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 return ret;
1614}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001615EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001617/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001618static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001619{
1620 struct kprobe *kp;
1621
1622 list_for_each_entry_rcu(kp, &ap->list, list)
1623 if (!kprobe_disabled(kp))
1624 /*
1625 * There is an active probe on the list.
1626 * We can't disable this ap.
1627 */
1628 return 0;
1629
1630 return 1;
1631}
1632
1633/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001634static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001635{
1636 struct kprobe *orig_p;
Jessica Yu297f9232018-01-10 00:51:24 +01001637 int ret;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001638
1639 /* Get an original kprobe for return */
1640 orig_p = __get_valid_kprobe(p);
1641 if (unlikely(orig_p == NULL))
Jessica Yu297f9232018-01-10 00:51:24 +01001642 return ERR_PTR(-EINVAL);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001643
1644 if (!kprobe_disabled(p)) {
1645 /* Disable probe if it is a child probe */
1646 if (p != orig_p)
1647 p->flags |= KPROBE_FLAG_DISABLED;
1648
1649 /* Try to disarm and disable this/parent probe */
1650 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001651 /*
1652 * If kprobes_all_disarmed is set, orig_p
1653 * should have already been disarmed, so
1654 * skip unneed disarming process.
1655 */
Jessica Yu297f9232018-01-10 00:51:24 +01001656 if (!kprobes_all_disarmed) {
1657 ret = disarm_kprobe(orig_p, true);
1658 if (ret) {
1659 p->flags &= ~KPROBE_FLAG_DISABLED;
1660 return ERR_PTR(ret);
1661 }
1662 }
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001663 orig_p->flags |= KPROBE_FLAG_DISABLED;
1664 }
1665 }
1666
1667 return orig_p;
1668}
1669
Masami Hiramatsu98616682008-04-28 02:14:28 -07001670/*
1671 * Unregister a kprobe without a scheduler synchronization.
1672 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001673static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001674{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001675 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001676
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001677 /* Disable kprobe. This will disarm it if needed. */
1678 ap = __disable_kprobe(p);
Jessica Yu297f9232018-01-10 00:51:24 +01001679 if (IS_ERR(ap))
1680 return PTR_ERR(ap);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001681
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001682 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001683 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001684 * This probe is an independent(and non-optimized) kprobe
1685 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001686 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001687 goto disarmed;
1688
1689 /* Following process expects this probe is an aggrprobe */
1690 WARN_ON(!kprobe_aggrprobe(ap));
1691
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001692 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1693 /*
1694 * !disarmed could be happen if the probe is under delayed
1695 * unoptimizing.
1696 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001697 goto disarmed;
1698 else {
1699 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001700 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001701 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001702 if ((list_p != p) && (list_p->post_handler))
1703 goto noclean;
1704 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001705 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001706 }
1707noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001708 /*
1709 * Remove from the aggrprobe: this path will do nothing in
1710 * __unregister_kprobe_bottom().
1711 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001712 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001713 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1714 /*
1715 * Try to optimize this probe again, because post
1716 * handler may have been changed.
1717 */
1718 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001719 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001720 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001721
1722disarmed:
1723 hlist_del_rcu(&ap->hlist);
1724 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001725}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001726
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001727static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001728{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001729 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001730
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001731 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001732 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001733 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001734 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001735 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001736 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001737 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001738 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001739 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001740 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741}
1742
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001743int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001744{
1745 int i, ret = 0;
1746
1747 if (num <= 0)
1748 return -EINVAL;
1749 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001750 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001751 if (ret < 0) {
1752 if (i > 0)
1753 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001754 break;
1755 }
1756 }
1757 return ret;
1758}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001759EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001760
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001761void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001762{
1763 unregister_kprobes(&p, 1);
1764}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001765EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001766
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001767void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001768{
1769 int i;
1770
1771 if (num <= 0)
1772 return;
1773 mutex_lock(&kprobe_mutex);
1774 for (i = 0; i < num; i++)
1775 if (__unregister_kprobe_top(kps[i]) < 0)
1776 kps[i]->addr = NULL;
1777 mutex_unlock(&kprobe_mutex);
1778
1779 synchronize_sched();
1780 for (i = 0; i < num; i++)
1781 if (kps[i]->addr)
1782 __unregister_kprobe_bottom(kps[i]);
1783}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001784EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001785
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301786int __weak kprobe_exceptions_notify(struct notifier_block *self,
1787 unsigned long val, void *data)
Naveen N. Raofc62d022017-02-08 01:24:14 +05301788{
1789 return NOTIFY_DONE;
1790}
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301791NOKPROBE_SYMBOL(kprobe_exceptions_notify);
Naveen N. Raofc62d022017-02-08 01:24:14 +05301792
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793static struct notifier_block kprobe_exceptions_nb = {
1794 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001795 .priority = 0x7fffffff /* we need to be notified first */
1796};
1797
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001798unsigned long __weak arch_deref_entry_point(void *entry)
1799{
1800 return (unsigned long)entry;
1801}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001803#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001804/*
1805 * This kprobe pre_handler is registered with every kretprobe. When probe
1806 * hits it will set up the return probe.
1807 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001808static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001809{
1810 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001811 unsigned long hash, flags = 0;
1812 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001813
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001814 /*
1815 * To avoid deadlocks, prohibit return probing in NMI contexts,
1816 * just skip the probe and increase the (inexact) 'nmissed'
1817 * statistical counter, so that the user is informed that
1818 * something happened:
1819 */
1820 if (unlikely(in_nmi())) {
1821 rp->nmissed++;
1822 return 0;
1823 }
1824
1825 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001826 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001827 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001828 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001829 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001830 struct kretprobe_instance, hlist);
1831 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001832 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001833
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001834 ri->rp = rp;
1835 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001836
Jiang Liu55ca6142012-02-03 15:37:16 -08001837 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1838 raw_spin_lock_irqsave(&rp->lock, flags);
1839 hlist_add_head(&ri->hlist, &rp->free_instances);
1840 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001841 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001842 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001843
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001844 arch_prepare_kretprobe(ri, regs);
1845
1846 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001847 INIT_HLIST_NODE(&ri->hlist);
1848 kretprobe_table_lock(hash, &flags);
1849 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1850 kretprobe_table_unlock(hash, &flags);
1851 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001852 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001853 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001854 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001855 return 0;
1856}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001857NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001858
Naveen N. Rao659b9572017-07-07 22:37:24 +05301859bool __weak arch_kprobe_on_func_entry(unsigned long offset)
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301860{
1861 return !offset;
1862}
1863
Naveen N. Rao659b9572017-07-07 22:37:24 +05301864bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301865{
1866 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1867
1868 if (IS_ERR(kp_addr))
1869 return false;
1870
1871 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
Naveen N. Rao659b9572017-07-07 22:37:24 +05301872 !arch_kprobe_on_func_entry(offset))
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301873 return false;
1874
1875 return true;
1876}
1877
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001878int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001879{
1880 int ret = 0;
1881 struct kretprobe_instance *inst;
1882 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001883 void *addr;
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301884
Naveen N. Rao659b9572017-07-07 22:37:24 +05301885 if (!kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05301886 return -EINVAL;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001887
1888 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001889 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001890 if (IS_ERR(addr))
1891 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001892
1893 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1894 if (kretprobe_blacklist[i].addr == addr)
1895 return -EINVAL;
1896 }
1897 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001898
1899 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001900 rp->kp.post_handler = NULL;
1901 rp->kp.fault_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001902
1903 /* Pre-allocate memory for max kretprobe instances */
1904 if (rp->maxactive <= 0) {
1905#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001906 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001907#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301908 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001909#endif
1910 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001911 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001912 INIT_HLIST_HEAD(&rp->free_instances);
1913 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001914 inst = kmalloc(sizeof(struct kretprobe_instance) +
1915 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001916 if (inst == NULL) {
1917 free_rp_inst(rp);
1918 return -ENOMEM;
1919 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001920 INIT_HLIST_NODE(&inst->hlist);
1921 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001922 }
1923
1924 rp->nmissed = 0;
1925 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001926 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001927 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001928 free_rp_inst(rp);
1929 return ret;
1930}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001931EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001932
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001933int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001934{
1935 int ret = 0, i;
1936
1937 if (num <= 0)
1938 return -EINVAL;
1939 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001940 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001941 if (ret < 0) {
1942 if (i > 0)
1943 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001944 break;
1945 }
1946 }
1947 return ret;
1948}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001949EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001950
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001951void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001952{
1953 unregister_kretprobes(&rp, 1);
1954}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001955EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001956
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001957void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001958{
1959 int i;
1960
1961 if (num <= 0)
1962 return;
1963 mutex_lock(&kprobe_mutex);
1964 for (i = 0; i < num; i++)
1965 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1966 rps[i]->kp.addr = NULL;
1967 mutex_unlock(&kprobe_mutex);
1968
1969 synchronize_sched();
1970 for (i = 0; i < num; i++) {
1971 if (rps[i]->kp.addr) {
1972 __unregister_kprobe_bottom(&rps[i]->kp);
1973 cleanup_rp_inst(rps[i]);
1974 }
1975 }
1976}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001977EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001978
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001979#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001980int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001981{
1982 return -ENOSYS;
1983}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001984EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001985
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001986int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001987{
1988 return -ENOSYS;
1989}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001990EXPORT_SYMBOL_GPL(register_kretprobes);
1991
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001992void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001993{
1994}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001995EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001996
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001997void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001998{
1999}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002000EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002001
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002002static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002003{
2004 return 0;
2005}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002006NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002007
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002008#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002009
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002010/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002011static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002012{
2013 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002014
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002015 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002016 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002017 /*
2018 * If this is an aggr_kprobe, we have to list all the
2019 * chained probes and mark them GONE.
2020 */
2021 list_for_each_entry_rcu(kp, &p->list, list)
2022 kp->flags |= KPROBE_FLAG_GONE;
2023 p->post_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002024 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002025 }
2026 /*
2027 * Here, we can remove insn_slot safely, because no thread calls
2028 * the original probed function (which will be freed soon) any more.
2029 */
2030 arch_remove_kprobe(p);
2031}
2032
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002033/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002034int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002035{
2036 int ret = 0;
Jessica Yu297f9232018-01-10 00:51:24 +01002037 struct kprobe *p;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002038
2039 mutex_lock(&kprobe_mutex);
2040
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002041 /* Disable this kprobe */
Jessica Yu297f9232018-01-10 00:51:24 +01002042 p = __disable_kprobe(kp);
2043 if (IS_ERR(p))
2044 ret = PTR_ERR(p);
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002045
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002046 mutex_unlock(&kprobe_mutex);
2047 return ret;
2048}
2049EXPORT_SYMBOL_GPL(disable_kprobe);
2050
2051/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002052int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002053{
2054 int ret = 0;
2055 struct kprobe *p;
2056
2057 mutex_lock(&kprobe_mutex);
2058
2059 /* Check whether specified probe is valid. */
2060 p = __get_valid_kprobe(kp);
2061 if (unlikely(p == NULL)) {
2062 ret = -EINVAL;
2063 goto out;
2064 }
2065
2066 if (kprobe_gone(kp)) {
2067 /* This kprobe has gone, we couldn't enable it. */
2068 ret = -EINVAL;
2069 goto out;
2070 }
2071
2072 if (p != kp)
2073 kp->flags &= ~KPROBE_FLAG_DISABLED;
2074
2075 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2076 p->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01002077 ret = arm_kprobe(p);
2078 if (ret)
2079 p->flags |= KPROBE_FLAG_DISABLED;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002080 }
2081out:
2082 mutex_unlock(&kprobe_mutex);
2083 return ret;
2084}
2085EXPORT_SYMBOL_GPL(enable_kprobe);
2086
Masami Hiramatsu44585152018-04-28 21:36:33 +09002087/* Caller must NOT call this in usual path. This is only for critical case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002088void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002089{
Masami Hiramatsu44585152018-04-28 21:36:33 +09002090 pr_err("Dumping kprobe:\n");
2091 pr_err("Name: %s\nOffset: %x\nAddress: %pS\n",
2092 kp->symbol_name, kp->offset, kp->addr);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002093}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002094NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002095
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002096/*
2097 * Lookup and populate the kprobe_blacklist.
2098 *
2099 * Unlike the kretprobe blacklist, we'll need to determine
2100 * the range of addresses that belong to the said functions,
2101 * since a kprobe need not necessarily be at the beginning
2102 * of a function.
2103 */
2104static int __init populate_kprobe_blacklist(unsigned long *start,
2105 unsigned long *end)
2106{
2107 unsigned long *iter;
2108 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002109 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002110
2111 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002112 entry = arch_deref_entry_point((void *)*iter);
2113
2114 if (!kernel_text_address(entry) ||
Masami Hiramatsu44585152018-04-28 21:36:33 +09002115 !kallsyms_lookup_size_offset(entry, &size, &offset))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002116 continue;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002117
2118 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2119 if (!ent)
2120 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002121 ent->start_addr = entry;
2122 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002123 INIT_LIST_HEAD(&ent->list);
2124 list_add_tail(&ent->list, &kprobe_blacklist);
2125 }
2126 return 0;
2127}
2128
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002129/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002130static int kprobes_module_callback(struct notifier_block *nb,
2131 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002132{
2133 struct module *mod = data;
2134 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002135 struct kprobe *p;
2136 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002137 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002138
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002139 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002140 return NOTIFY_DONE;
2141
2142 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002143 * When MODULE_STATE_GOING was notified, both of module .text and
2144 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2145 * notified, only .init.text section would be freed. We need to
2146 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002147 */
2148 mutex_lock(&kprobe_mutex);
2149 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2150 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002151 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002152 if (within_module_init((unsigned long)p->addr, mod) ||
2153 (checkcore &&
2154 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002155 /*
2156 * The vaddr this probe is installed will soon
2157 * be vfreed buy not synced to disk. Hence,
2158 * disarming the breakpoint isn't needed.
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002159 *
2160 * Note, this will also move any optimized probes
2161 * that are pending to be removed from their
2162 * corresponding lists to the freeing_list and
2163 * will not be touched by the delayed
2164 * kprobe_optimizer work handler.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002165 */
2166 kill_kprobe(p);
2167 }
2168 }
2169 mutex_unlock(&kprobe_mutex);
2170 return NOTIFY_DONE;
2171}
2172
2173static struct notifier_block kprobe_module_nb = {
2174 .notifier_call = kprobes_module_callback,
2175 .priority = 0
2176};
2177
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002178/* Markers of _kprobe_blacklist section */
2179extern unsigned long __start_kprobe_blacklist[];
2180extern unsigned long __stop_kprobe_blacklist[];
2181
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182static int __init init_kprobes(void)
2183{
2184 int i, err = 0;
2185
2186 /* FIXME allocate the probe table, currently defined statically */
2187 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002188 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002190 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002191 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002194 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2195 __stop_kprobe_blacklist);
2196 if (err) {
2197 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2198 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002199 }
2200
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002201 if (kretprobe_blacklist_size) {
2202 /* lookup the function address from its name */
2203 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
Naveen N. Rao49e0b462017-04-19 18:21:00 +05302204 kretprobe_blacklist[i].addr =
Naveen N. Rao290e3072017-04-19 18:21:01 +05302205 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002206 if (!kretprobe_blacklist[i].addr)
2207 printk("kretprobe: lookup failed: %s\n",
2208 kretprobe_blacklist[i].name);
2209 }
2210 }
2211
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002212#if defined(CONFIG_OPTPROBES)
2213#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002214 /* Init kprobe_optinsn_slots */
2215 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2216#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002217 /* By default, kprobes can be optimized */
2218 kprobes_allow_optimization = true;
2219#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002220
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002221 /* By default, kprobes are armed */
2222 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002223
Rusty Lynch67729262005-07-05 18:54:50 -07002224 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002225 if (!err)
2226 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002227 if (!err)
2228 err = register_module_notifier(&kprobe_module_nb);
2229
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002230 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002231
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002232 if (!err)
2233 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 return err;
2235}
2236
Srinivasa Ds346fd592007-02-20 13:57:54 -08002237#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002238static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002239 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002240{
2241 char *kprobe_type;
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002242 void *addr = p->addr;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002243
2244 if (p->pre_handler == pre_handler_kretprobe)
2245 kprobe_type = "r";
Srinivasa Ds346fd592007-02-20 13:57:54 -08002246 else
2247 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002248
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002249 if (!kallsyms_show_value())
2250 addr = NULL;
2251
Srinivasa Ds346fd592007-02-20 13:57:54 -08002252 if (sym)
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002253 seq_printf(pi, "%px %s %s+0x%x %s ",
2254 addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002255 (modname ? modname : " "));
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002256 else /* try to use %pS */
2257 seq_printf(pi, "%px %s %pS ",
2258 addr, kprobe_type, p->addr);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002259
2260 if (!pp)
2261 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002262 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002263 (kprobe_gone(p) ? "[GONE]" : ""),
2264 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002265 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2266 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002267}
2268
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002269static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002270{
2271 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2272}
2273
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002274static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002275{
2276 (*pos)++;
2277 if (*pos >= KPROBE_TABLE_SIZE)
2278 return NULL;
2279 return pos;
2280}
2281
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002282static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002283{
2284 /* Nothing to do */
2285}
2286
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002287static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002288{
2289 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002290 struct kprobe *p, *kp;
2291 const char *sym = NULL;
2292 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002293 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002294 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002295
2296 head = &kprobe_table[i];
2297 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002298 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002299 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002300 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002301 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002302 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002303 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002304 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002305 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002306 }
2307 preempt_enable();
2308 return 0;
2309}
2310
James Morris88e9d342009-09-22 16:43:43 -07002311static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002312 .start = kprobe_seq_start,
2313 .next = kprobe_seq_next,
2314 .stop = kprobe_seq_stop,
2315 .show = show_kprobe_addr
2316};
2317
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002318static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002319{
2320 return seq_open(filp, &kprobes_seq_ops);
2321}
2322
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002323static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002324 .open = kprobes_open,
2325 .read = seq_read,
2326 .llseek = seq_lseek,
2327 .release = seq_release,
2328};
2329
Masami Hiramatsu63724742014-04-17 17:18:49 +09002330/* kprobes/blacklist -- shows which functions can not be probed */
2331static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2332{
2333 return seq_list_start(&kprobe_blacklist, *pos);
2334}
2335
2336static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2337{
2338 return seq_list_next(v, &kprobe_blacklist, pos);
2339}
2340
2341static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2342{
2343 struct kprobe_blacklist_entry *ent =
2344 list_entry(v, struct kprobe_blacklist_entry, list);
2345
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002346 /*
2347 * If /proc/kallsyms is not showing kernel address, we won't
2348 * show them here either.
2349 */
2350 if (!kallsyms_show_value())
2351 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2352 (void *)ent->start_addr);
2353 else
2354 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2355 (void *)ent->end_addr, (void *)ent->start_addr);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002356 return 0;
2357}
2358
2359static const struct seq_operations kprobe_blacklist_seq_ops = {
2360 .start = kprobe_blacklist_seq_start,
2361 .next = kprobe_blacklist_seq_next,
2362 .stop = kprobe_seq_stop, /* Reuse void function */
2363 .show = kprobe_blacklist_seq_show,
2364};
2365
2366static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2367{
2368 return seq_open(filp, &kprobe_blacklist_seq_ops);
2369}
2370
2371static const struct file_operations debugfs_kprobe_blacklist_ops = {
2372 .open = kprobe_blacklist_open,
2373 .read = seq_read,
2374 .llseek = seq_lseek,
2375 .release = seq_release,
2376};
2377
Jessica Yu12310e342018-01-10 00:51:23 +01002378static int arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002379{
2380 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002381 struct kprobe *p;
Jessica Yu12310e342018-01-10 00:51:23 +01002382 unsigned int i, total = 0, errors = 0;
2383 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002384
2385 mutex_lock(&kprobe_mutex);
2386
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002387 /* If kprobes are armed, just return */
2388 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002389 goto already_enabled;
2390
Wang Nan977ad482015-02-13 14:40:24 -08002391 /*
2392 * optimize_kprobe() called by arm_kprobe() checks
2393 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2394 * arm_kprobe.
2395 */
2396 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002397 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002398 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2399 head = &kprobe_table[i];
Jessica Yu12310e342018-01-10 00:51:23 +01002400 /* Arm all kprobes on a best-effort basis */
2401 hlist_for_each_entry_rcu(p, head, hlist) {
2402 if (!kprobe_disabled(p)) {
2403 err = arm_kprobe(p);
2404 if (err) {
2405 errors++;
2406 ret = err;
2407 }
2408 total++;
2409 }
2410 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002411 }
2412
Jessica Yu12310e342018-01-10 00:51:23 +01002413 if (errors)
2414 pr_warn("Kprobes globally enabled, but failed to arm %d out of %d probes\n",
2415 errors, total);
2416 else
2417 pr_info("Kprobes globally enabled\n");
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002418
2419already_enabled:
2420 mutex_unlock(&kprobe_mutex);
Jessica Yu12310e342018-01-10 00:51:23 +01002421 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002422}
2423
Jessica Yu297f9232018-01-10 00:51:24 +01002424static int disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002425{
2426 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002427 struct kprobe *p;
Jessica Yu297f9232018-01-10 00:51:24 +01002428 unsigned int i, total = 0, errors = 0;
2429 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002430
2431 mutex_lock(&kprobe_mutex);
2432
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002433 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002434 if (kprobes_all_disarmed) {
2435 mutex_unlock(&kprobe_mutex);
Jessica Yu297f9232018-01-10 00:51:24 +01002436 return 0;
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002437 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002438
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002439 kprobes_all_disarmed = true;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002440
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002441 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2442 head = &kprobe_table[i];
Jessica Yu297f9232018-01-10 00:51:24 +01002443 /* Disarm all kprobes on a best-effort basis */
Sasha Levinb67bfe02013-02-27 17:06:00 -08002444 hlist_for_each_entry_rcu(p, head, hlist) {
Jessica Yu297f9232018-01-10 00:51:24 +01002445 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2446 err = disarm_kprobe(p, false);
2447 if (err) {
2448 errors++;
2449 ret = err;
2450 }
2451 total++;
2452 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002453 }
2454 }
Jessica Yu297f9232018-01-10 00:51:24 +01002455
2456 if (errors)
2457 pr_warn("Kprobes globally disabled, but failed to disarm %d out of %d probes\n",
2458 errors, total);
2459 else
2460 pr_info("Kprobes globally disabled\n");
2461
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002462 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002463
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002464 /* Wait for disarming all kprobes by optimizer */
2465 wait_for_kprobe_optimizer();
Jessica Yu297f9232018-01-10 00:51:24 +01002466
2467 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002468}
2469
2470/*
2471 * XXX: The debugfs bool file interface doesn't allow for callbacks
2472 * when the bool state is switched. We can reuse that facility when
2473 * available
2474 */
2475static ssize_t read_enabled_file_bool(struct file *file,
2476 char __user *user_buf, size_t count, loff_t *ppos)
2477{
2478 char buf[3];
2479
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002480 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002481 buf[0] = '1';
2482 else
2483 buf[0] = '0';
2484 buf[1] = '\n';
2485 buf[2] = 0x00;
2486 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2487}
2488
2489static ssize_t write_enabled_file_bool(struct file *file,
2490 const char __user *user_buf, size_t count, loff_t *ppos)
2491{
2492 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002493 size_t buf_size;
Jessica Yu12310e342018-01-10 00:51:23 +01002494 int ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002495
2496 buf_size = min(count, (sizeof(buf)-1));
2497 if (copy_from_user(buf, user_buf, buf_size))
2498 return -EFAULT;
2499
Mathias Krause10fb46d2013-07-03 15:05:39 -07002500 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002501 switch (buf[0]) {
2502 case 'y':
2503 case 'Y':
2504 case '1':
Jessica Yu12310e342018-01-10 00:51:23 +01002505 ret = arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002506 break;
2507 case 'n':
2508 case 'N':
2509 case '0':
Jessica Yu297f9232018-01-10 00:51:24 +01002510 ret = disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002511 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002512 default:
2513 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002514 }
2515
Jessica Yu12310e342018-01-10 00:51:23 +01002516 if (ret)
2517 return ret;
2518
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002519 return count;
2520}
2521
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002522static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002523 .read = read_enabled_file_bool,
2524 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002525 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002526};
2527
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002528static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002529{
2530 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002531 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002532
2533 dir = debugfs_create_dir("kprobes", NULL);
2534 if (!dir)
2535 return -ENOMEM;
2536
Masami Hiramatsuf2a3ab32018-04-28 21:35:01 +09002537 file = debugfs_create_file("list", 0400, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002538 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002539 if (!file)
2540 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002541
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002542 file = debugfs_create_file("enabled", 0600, dir,
2543 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002544 if (!file)
2545 goto error;
2546
Masami Hiramatsuf2a3ab32018-04-28 21:35:01 +09002547 file = debugfs_create_file("blacklist", 0400, dir, NULL,
Masami Hiramatsu63724742014-04-17 17:18:49 +09002548 &debugfs_kprobe_blacklist_ops);
2549 if (!file)
2550 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002551
Srinivasa Ds346fd592007-02-20 13:57:54 -08002552 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002553
2554error:
2555 debugfs_remove(dir);
2556 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002557}
2558
2559late_initcall(debugfs_kprobe_init);
2560#endif /* CONFIG_DEBUG_FS */
2561
2562module_init(init_kprobes);